The following table contains an examples of a valid Agent request message:
XML element |
Description |
|
This is the root element of any message. The |
|
The target Agent operator that the request should be sent to for processing. Note: When using the |
|
The |
|
Every request begins with the name of the interface providing the desired functionality. The interface name is always the same as the name of the operator (see |
|
This is the name of the API call. |
|
This and the following elements are the API call parameters. |
|
Parameter. |
|
Parameter. |
|
Closing tag. |
|
Closing tag |
|
Closing tag |
|
Closing tag |
A response message may look similar to the following example:
XML element |
Description |
|
The root element. The |
|
The name of the operator that processed the request and generated this response as a result. |
|
The client who sent the initial request message. This value is generated and used internally by Agent. |
|
The message body. |
|
Just like a request message, every response message also begins with the name of the interface. The block that follows this element contains the returned data. |
|
Data. |
|
Data. |
|
Data. |
|
Data. |
|
Closing tag. |
|
Closing tag. |
|
Closing tag. |
|
Closing tag. |
|
Closing tag. |