<object>query SOAP Response Structure

An objectquery SOAP request 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:????QueryResponse>
      <resultsxsi:type="USER-TYPES:????QueryResults">
        <resultCodesxsi:type="BASIC-TYPES:ResultCodes">
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttributexsi:type="USER-TYPES:???AttributeList">
          <attributeListxsi:type="USER-TYPES:???AttributeSet">
            <attributesxsi:type="USER-TYPES:???Attribute">
              <valuexsi:type="xsd:string">?????</value>
              <attributeID>!!!!</attributeID>
            </attributes>
          </attributeList>
        </resultAttribute>
        <resultCount>??????</resultCount>
        <errorStackxsi:type="BASIC-TYPES:ErrorStack"/>
      </results>
    </adm:????QueryResponse>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element should only contain an objectQueryResponse element, where object specifies the requested object (line 9). The objectQueryResponse element always contains a results element, which in turn 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.

• ResultCount. Required. This element specifies the number of objects that matched the specified search criteria. If queryOption.count is set to true in the query request, then only the ResultCount element will be returned in the response.

In this case, the resultattribute element is used to refer to attributeList elements for the specified object (object). Each attributeList element specifies one search result row.