Response Status

The XML response to a server request contains an <ap:Status> element that indicates whether or not the action was successfully processed. It also contains information to help determine the problem if an error does occur.

The <ap:Status> element provides the version number of the Action Processor and the date and time the response was returned to the application. For example: 

      .
      .
      .
<ap:Status>
   <ap:Version>1.1.0</ap:Version>
   <ap:ReturnCode>0</ap:ReturnCode>
   <ap:ReturnComment><![CDATA[ The Action was processed successfully. Check the individual Request Results for their status.</ap:ReturnComment>
   <ap:ReturnDateTime>2011-02-28T10:37:11.671-0800</ap:ReturnDateTime>
</ap:Status>
      .
      .
      .

A return code of 0 (zero) in the <ap:ReturnCode> element indicates there were no unexpected problems executing the requests.

Most other return codes are text, and are the same codes returned by Web Service calls. Refer to documentation for related Web Service calls for more details on those codes. An example is shown below: 

      .
      .
      .
<ap:Status>
   <ap:Version>1.1.0 v19</ap:Version>
   <ap:ReturnCode>INVALID_ENTITY_REFERENCE_EXCEPTION</ap:ReturnCode>
   <ap:ReturnComment>Invalid organisational entity reference: [version: null, type: RESOURCE, guid: _bnFngALvEeCHF4vrCq9WPw]</ap:ReturnComment>
   <ap:ReturnDateTime>2011-03-10T15:01:15.218-0800</ap:ReturnDateTime>
</ap:Status>
      .
      .
      .

The return comment will usually provide more detailed information about any problem encountered.

If multiple requests are submitted in one batch, execution of those requests on the server are handled one at a time, and if one request fails, the exception is returned and the remaining requests are not executed.

The value in the <ap:ReturnDateTime> element is in the form: 

yyyy-mm-ddThh:nn:ss.uuu+/-oooo

where:

  • yyyy-mm-dd = year, month, and day the XML response was sent
  • T = separator between the date and time
  • hh:nn:ss.uuu = hour, minute, second, and microsecond the XML response was sent
  • +/- = indicates whether the offset from GMT is plus (+) or minus (-)
  • oooo = offset (in 2400-hour format) from Greenwich Mean Time (GMT)

For example: 

2006-04-26T08:02:02.146-0700

In this example, the “-0700” indicates minus 7 hours from GMT.