logon/logoff SOAP Response Structure

logon and logoff SOAP responses have the same format. A logon SOAP response typically use 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:logonResponse>
      <resultsxsi:type="CREDENTIAL-TYPES:CredentialResults">
        <resultCodesxsi:type="BASIC-TYPES:ResultCodes">
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttributexsi:type="CREDENTIAL-TYPES:CredentialAttributeSet">
          <!--Zero or more repetitions:-->
          <attributes>
            <valuexsi:type="xsd:!!!!!!">?????</value>
            <attributeID>?????</attributeID>
          </attributes>
        </resultAttribute>
        <errorStackxsi:type="BASIC-TYPES:ErrorStack"/>
      </results>
    </adm:logonResponse>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element should only contain a logonResponse element (line 9). The logonResponse 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.

In this case, the resultattribute element is used to refer to credential attribute elements.