This following documentation is intended for use when developing an alternate interface client (e.g. replacement for bmui.cgi). It may also be helpful for understanding the client/server interaction for debugging purposes.

In general, the data passed between the server and client is of two forms: simple string and parameter list. Simple strings typically convey some message while parameter lists typically contain data.

Each record exchanged is prefixed with a code (number). Here are the currently supported codes:

Parameter lists are formatted as a series of 'variable=value' single quoted strings. For example: 'lname=Smith''fname=Bill'. They are usually terminated with the code 4000.

Shown below are the currently supported commands. C indicates client requests and S indicates successful bmuid responses. Failure results aren't shown. In general, the client should be coded to handle any of the codes listed above.

The VIRTUALCOMPANY command is optional. If supplied, it must be the first command issued, otherwise it is ignored.

The VERSION command can be issued anytime.

The USER and PASS commands authenticate the particular combination of client/server. They must be must be issued and accepted before the AUTH command.

The AUTH command authenticates the end user. The user_login name and user_password are ciphered if the bmui_cidx value is > 0.

The remaining commands (with the exception of QUIT) can only be issued after the user has been authenticated. The GETLIST command can only be used to retrieve lists whose names end in a 's'. When requesting a list specify the name without the 's'. For Example: 'list=mspeed' for the list named mspeeds.

GETCONFIGURATION returns a list of parameters from the globalconf table. The columns returned are dictated by the tabledefaults entries.

DETPOPDATA returns pop data and a pop number that matches the supplied filters. POP_FIELDS is optional, if not supplied, PHONENUMBER is the default.

SERVDEFS returns a list of service definitions that match the passed search filters. Note that what is returned is dependent on the servdefselection table contents and the VIRTUALCOMPANY value, if any. If action=getsrvc and number is also passed, the list of eligible servdefs for service changes (from number's servdef) is returned instead. A list is returned for every matched servdef. Each list is terminated by the end of list code (4000). The end of the results is denote by the 5000 code.

GETACCT retrieves all the READ and READ/WRITE columns for the specified account. It can't be used to retrieve an account that hasn't been authenticated. If the optional 'T' flag is supplied, additional labels for each branch of the account/user/service tree are also returned.

GETUSER retrieves all the READ and READ/WRITE columns for the specified user. It can't be used to retrieve a user that hasn't been authenticated. If the optional 'T' flag is supplied, additional labels for each branch of the user/service tree are also returned.

GETSRVC retrieves all the READ and READ/WRITE columns for the specified service.

GETSTMT returns a customer statement using the as of date supplied. Date is formatted as 'YYYY-MM-DD'. Note that non ascii characters are hex escaped (for example \n becomes =0A) in the output.

GETCALL returns datacall statistics for the user. Note the non terminated list call.

CREATECUST creates an account/user/service triplet and optionally charges a credit card. It must be passed all the required values (from tabledefaults) for each of these tables.

UPDATEACCT updates an account record. It must be passed all the required columns.

UPDATEUSER updates a user record. It must be passed all the required columns.

UPDATESERVICE updates a user record. It must be passed all the required columns.

CHANGESERVICE converts an existing service from one service definition to another.

ADDUSER adds a user and a service to an existing account.

ADDSRVC adds a service to an user.

QUIT terminates the connection. The daemon instance is shut down.