Generic Message Type

The Web services use a Generic Message (GenericMsg) type that provides the following fields.

GenericMsg

Name	Type	Description
Custom Attributes	CustomAttributeMsg[]	An optional CustomAttributeMsg with custom-defined Name and Value attributes.
MessageId	Integer	The message version for this type of record response. May be changed to reflect a specific format for the request message as changes are implemented.
CorrelationId	Integer	Record tracking identifier sent with the in-message. The client uses the identifier to correlate request and response messages containing the record.

The Generic Request type and Generic Response type are extensions of the (GenericMsg) type.

Generic Request Type

The Generic Request type consists of the following members:

• The security token (TokenId) passed in with the request. The TokenId is received from a call to the Authentication Web service. The security token is required to allow the request to be accepted.

  The time to live (TTL) value for the TokenId can be extended by selecting the value TokenNeverExpires.

• The identifier of the related Service Request (ServiceRequestId).

• An indication of the request origination (Source).

The generic in-message (GenericInMsg) type is an extension of the GenericMsg type.

GenericInMsg

Name	Type	Description
MessageState	String	State of the in-message.
ServiceMessageId	Integer	Message identifier for the response. May be changed to reflect a specific format for the request message as changes are implemented.

Generic Response Type

The Generic Response Type consists of the following members:

• The Transaction Result (TrxResult) — a free form description of the request status usually containing an error description when an Error status is reported.

• The security token (TokenId) passed in with the request.

• The Status (TrxStatus) identifying the application import processing status of the request as one of the following Error Types:

  Error Types

  TrxStatus	Enumeration
  ErrorArguments	Any error in values provided.
  ErrorBusinessLogic	Error at the business logic layer.
  ErrorMultiple	Multiple error condition.
  ErrorSecurity	Security exception.
  ErrorSQL	Errors in the SQL server.
  ErrorSystem	System exception.
  ErrorWebService	Error in Web service or pipeline.
  OK	The transaction was successful.

The generic out-message GenericOutMsg type is an extension of the GenericMsg type.

GenericOutMsg

Name	Type	Description
MessageResult	String	String value with additional details on a failure.
MessageStatus	String	One of the values (MessageStatusType) that describes the processing status of this message: OK FailedValidation FailedExecution FailedAuthorization FailedOther
MessageErrorCode	String	Error code for out-message. Error code (0) means no errors.
ExceptionDetail	String	Additional parameter to add exception details to some exceptions.
HostName	String	Additional parameter to add the host name to the out-message.
DataSource	String	Additional parameter to add the data source to error messages.
InitialCatalog	String	Additional parameter to add the initial catalog to error messages.