Common Elements

Most of the web service request or response bodies for the application contain the following elements and can be referred to in the following tables. The rest of the elements for each web service are detailed with the respective topics.

The following three elements are included in all the request and response bodies except the authenticate operation:
Element Type Cardinality Description
businessTransactionId String Optional This is the unique identifier used for tracing across function calls. This is a free form field and not used internally.
correlationId String Optional This is the unique identifier used to correlate the request message with a response message. This is a free form field and not used internally.
sessionId String Optional This is a free form field that can be used to track messages.
The following four elements are repeated throughout the responses of the operations whenever there is a status sent back:
Element Type Cardinality Description
severity String Mandatory This is the entity severity result. The following are the valid values:
  • S - Success
  • W - Warning
  • E - Error
code String Mandatory This is the code indicating the result of this operation for this particular entity.
message String Mandatory This is the message indicating the result of this operation for this particular entity.
parameter String Mandatory This is the substitution parameter used in the message. If there are no substituted parameters, this list is empty. This information can be used to localize the message.