The QXXMLMsgs Message Set

The attributes described in the following table are used in the QXXMLMsgsRq and QXXMLMsgsRs messages, for example:

<QXXMLMsgsRq
           database = "C:\Program Files\QXpress\The Service Company.mde"
           loginuser = "Admin"
           loginpassword = "AdminPassword"
           ApplicationName = "Sample Estimate Program"
           ApplicationAccessPassword = "12345"
           responseData = "includeAll"
           onError = "stopOnError">
. . .
<QXXMLMsgsRs>

Attributes in QXXMLMsgs

Attribute	Restrictions	Meaning
database	Required	Identifies the full path to the QXpress database location.
loginuser	Required	If the QXpress user has user access permissions enabled in QXpress, this is the name of the user that is to log into the QXpress database. If they do not have permissions turned on, just use the "Admin" user.
loginpassword	Required	If the QXpress user has user access permissions enabled in QXpress, this is the password of the user that is to log into the QXpress database. If they do not have permissions turned on, just use the password "AdminPassword".
onError	Optional	Specifies how QXpress should proceed if it encounters an error in processing the current request: stopOnError: Stop processing when an error occurs. Requests that have already been processed will not be rolled back. The remaining requests will not be processed. continueOnError: Continue processing the remaining requests if an error occurs.
ApplicationName	Required	A descriptive name of your SDK application. QXpress users will see this name when you try to connect to their QXpress database, and will either accept or deny access.
ApplicationAccessPassword	Required	Based on your ApplicationName, you will have a unique ApplicationAccessPassword assigned to you. You must apply to Alocet Inc. for your ApplicationAccessPassword. To apply for a ApplicationAccessPassword for your ApplicationName, please email developer@alocet.com for further instructions.

Back to the top

Object Request and Response Messages

The attributes described in the following table are used in object request and response messages, for example:

<CustomerAddRq
           RequestID = "abcdef12345">
           responseData = "includeAll">
. . .
<CustomerAddRs
           requestID = "abcdef12345"
           statusCode = "0"
           statusSeverity = "Success"
           statusMessage = "The request was processed sucessfully, without errors.">

Attributes in Request and Response Messages

Attribute	Restrictions	Meaning
RequestID	Optional	Allows you to match a response to your request. If you set a RequestID value it will be returned, unchanged, in the corresponding response message.
responseData	Optional	Specifies how much of the response to include. If you do not need to parse the response, it is better to use the includeNone value, in order to optimize speed: includeAll: The normal response will be returned. includeNone: The response will include status information but no data.
statusCode	Required	A number that corresponds to a statusSeverity and statusMessage. For details about the possible statusCode values that can be returned, see Error Codes.
statusSeverity	Required	One of the following values: Success: The request was completed, and the results are consistent with what your application expected. Warning: The request was completed, but the results might not be consistent with what you expected. Error: The request was not completed. No data will appear in the server’s response after the statusMessage.
statusMessage	Required	An explanation of the success or error condition that is indicated by the statusCode. For details about the statusMessage values that can be returned, see Error Codes. In most cases, a success will produce no statusMessage.

Back to the top