Asynchronous message request/response

Message request header

All header content is under traceHeader element that contains traceIdentifier element with tracing information of incoming message.

TraceIndentifier parameters

ParameterTypeDescriptionMandatory
applicationIDstringIdentification of source application.Y
timestampdateTimeTimestamp of sent request.Y
correlationIDstring

Used to track calls from the service consumer to the API.
This parameter is free text, unique value (e.g. UUID), generated by the caller.
It is the responsibility of the application to generate a unique value and pass it during each call to the API.
Unique identifier (at least for specific application) serves for pairing asynchronous request/response messages.

Y
processIDstring

Used to track calls connected to one process (e.g. one process is "creating new customer" and it means calling creating customer, then activating him etc.)

This parameter is free text, unique value (e.g. UUID), generated by the caller.
It is the responsibility of the application to generate a unique value and pass it to all calls of one process.

N

 

SOAP example:

Validation of trace identifier from trace header

It's good practice to use validation functionality of allowed values in applicationID. This value is used for example in GUI Admin, auto confirmation delegation etc. For that we only have to register custom implementation of ExternalSystemIdentifierValidator interface. We can have an unlimited number of these implementations.

SOAP example of failed response for sync operation:

SOAP example of failed response for async. operation:

Message response

There is synchronnous response that indicates if input message was correctly saved into message queue for next processing.

SOAP example of successful response:

SOAP example of failed response:

 

If error occurred during incoming message processing (ThrottlingExceededException and StoppingException at this moment) then fault response is generated (identical for synchronnous message). Fault response contains error description and error code for clear indentification.

SOAP example with fault: