<object>execute SOAP Response Structure

Prev Next

An objectexecute SOAP response typically uses the following format:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:adm="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
<!-- ... Additional namespace declarations -->
  <soapenv:Header/>
  <soapenv:Body>
    <adm:????ExecuteResponse>
      <results xsi:type="USER-TYPES:?????Results">
        <resultCodes xsi:type="BASIC-TYPES:ResultCodes">
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttribute xsi:type="USER-TYPES:?????AttributeSet">
          <attributes xsi:type="USER-TYPES:????Attribute">
            <value xsi:type="xsd:string">?????????</value>
            <attributeID>!!!!!!!!!</attributeID>
          </attributes>
        </resultAttribute>
        <errorStack xsi:type="BASIC-TYPES:ErrorStack"/>
      </results>
    </adm:??????ExecuteResponse>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element should only contain an objectExecuteResponse element, where object specifies the requested object (line 9). The objectExecuteResponse element always contains a results element, which contains the following elements:

  • resultCodes (required). This element contains the following sub-elements:

    • returnCode. The operation return code indicating the overall result of the request processing.
    • statusCode. The operation status code indicating the reason for failure of any returnCode different from success (0).
    • returnCodeEnum. The identifier corresponding to the returnCode.
    • statusCodeEnum. The identifier corresponding to the statusCode.
  • resultAttribute (required). This element contains zero or more attributes elements.
  • errorStack (required). Contains zero or more errors elements.

    • errors. Each errors element contains the following sub-elements:

      • errorCode. The error code integer.
      • errorDesc. A string representation of the error code.

For a complete list of possible error codes, see Error codes and messages.

In this case, the resultAttribute element is used to refer to attributes elements for the specified object (object).