All replies from server contain XML response. A response includes always some certain aggregate <ResponseStatus>.
The format of response is following:
Level | Element name | Type and length | Occurs | Example | Description |
Root | Root | Aggr. | 1 | ||
1 | ResponseStatus | Aggr. | 1 | ||
2 | Status | Text | 1 | OK | OK or FAILED |
2 | Status | Text | 0...1 | Error processing data | Contains an error description in error cases |
2 | TimeStamp | DateTime | 1 | Request processing timestamp | |
1 | InsertedDataIdentifier | Text | 0...1 | 1234 | When data is added, this element is returned containing identifier of a newly added record |
1 | <reply specific element name> | Aggr. | 0...1 | When data is retrieved from Netvisor, this element contains data structure, specific for request type |
An example:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Root>
<ResponseStatus>
<Status>OK</Status>
<TimeStamp>9.10.2013 13:42:50</TimeStamp>
</ResponseStatus>
<Replies>
<InsertedDataIdentifier>31</InsertedDataIdentifier>
</Replies>
</Root>
You can get error messages in Finnish, Swedish or English based on the value of X-Netvisor-Interface-Language in requests header. Each reply contains an aggregate which tells you if the request was successful or not.
An example:
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Root>
<ResponseStatus>
<Status>FAILED</Status>
<Status>AUTHENTICATION_FAILED :: Integration partner not found, check documentation</Status>
<TimeStamp>7.4.2009 13:46:07</TimeStamp>
</ResponseStatus>
</Root>
Oliko tästä vastauksesta apua? Kyllä Ei
Send feedback