getSecureChallenge SOAP Response Structure

A getSecureChallenge SOAP response typically uses the following format:

<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:BASIC-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/BasicTypes.xsd"
  xmlns:AUTH-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Authentication"
  xmlns:CREDENTIAL-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/CredentialTypes.xsd"
  <!-- ... Additional namespace declarations -->
  <soapenv:Body>
    <AUTH-TYPES:getSecureChallengeRespond>
      <results xsi:type="CREDENTIAL-TYPES:CredentialResults">
        <resultCodes xsi:type="BASIC-TYPES:ResultCodes">
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttribute xsi:type="CREDENTIAL-TYPES:CredentialAttributeSet">
          <attributes xsi:type="CREDENTIAL-TYPES:CredentialAttribute">
            <value xsi:type="xsd:string">user1</value>
            <attributeID>CREDFLD_USERID</attributeID>
          </attributes>
          <attributes xsi:type="CREDENTIAL-TYPES:CredentialAttribute">
            <value xsi:type="xsd:string">master</value>
            <attributeID>CREDFLD_DOMAIN</attributeID>
          </attributes>
          <attributes xsi:type="CREDENTIAL-TYPES:CredentialAttribute">
            <value xsi:type="xsd:string">1481259140</value>
            <attributeID>CREDFLD_CHALLENGE_KEY</attributeID>
          </attributes>
          <attributes xsi:type="CREDENTIAL-TYPES:CredentialAttribute">
            <value xsi:type="xsd:string">VDS0000001-7</value>
            <attributeID>CREDFLD_SERIAL_NO</attributeID>
          </attributes>
          <attributes xsi:type="CREDENTIAL-TYPES:CredentialAttribute">
            <value xsi:type="xsd:string">00C1C3E400000128202D43FCAE28021F...</value>
            <attributeID>CREDFLD_REQUEST_MESSAGE</attributeID>
          </attributes>
        </resultAttribute>
        <errorStack xsi:type="BASIC-TYPES:ErrorStack"></errorStack>
      </results>
    </AUTH-TYPES:getSecureChallengeRespond>
  </soapenv:Body>
</SOAP-ENV:Envelope>

The SOAP body element must only contain a single getSecureChallengeRespond element (line 10). This element always contains a single result element, which in turn contains the following sub-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.

For this SOAP response the resultAttribute element refers to credential attribute elements.