All replies from server contain XML response. A response includes always some certain aggregate <ResponseStatus>.

The format of response is following:

LevelElement nameType and lengthOccursExampleDescription
RootRootAggr.1  
1ResponseStatusAggr.1  
2StatusText1OKOK or FAILED
2StatusText0...1Error processing dataContains an error description in error cases
2TimeStampDateTime1 Request processing timestamp
1InsertedDataIdentifierText0...11234When 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>



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.