Responses to Server Requests

Once the server has processed all of the individual requests in a server request, it consolidates the data under a single XML root element, <apActionResult>. This XML response is then sent back to the application via HTTP.

The format of the XML response is as follows:

<?xml version="1.0" encoding="utf-8" ?>
<ap:ActionResult xmlns:ap="http://tibco.com/bpm/actionprocessor">
   <ap:Status>
      <ap:Version></ap:Version>
      <ap:ReturnCode></ap:ReturnCode>
      <ap:ReturnComment></ap:ReturnComment>
      <ap:ReturnDateTime></ap:ReturnDateTime>
   </ap:Status>
   <ap:Requests>
      .
      .
      .
   </ap:Requests>
</ap:ActionResult>

Request-specific data (for example, information about the business service categories for a ListBusinessServiceCategories request) is included in the response under the <ap:Requests> element. For example:

<ap:Requests>
  <ap:ListBusinessServiceCategories Id="ApiSample.listBusinessServiceCategories">
    <ap:Categories>
       <ap:Category>
          <ap:Name>Acme</ap:Name>
          <ap:ChildCategories />
       </ap:Category>
       <ap:Category>
          <ap:Name>uncategorized</ap:Name>
          <ap:ChildCategories />
       </ap:Category>
       <ap:Category>
          <ap:Name>Sales</ap:Name>
          <ap:ChildCategories />
       </ap:Category>
       <ap:Category>
              .
              .
              .
    </ap:Categories>
  </ap:ListBusinessServiceCategories>
</ap:Requests>