updatePassword SOAP Response Structure

An updatePassword 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:aut="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Authentication">
  <!-- ... Additional namespace declarations -->
  <soapenv:Header/>
  <soapenv:Body>
    <aut:updatePasswordResponse>
      <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">????</value>
            <attributeID>!!!!!!!!!!!!!</attributeID>
          </attributes>
        </resultAttribute>
        <errorStack xsi:type="BASIC-TYPES:ErrorStack"/>
      </results>
    </aut:updatePasswordResponse>
  </soapenv:Body>
</soapenv:Envelope>

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

In this case, the resultAttribute element is used to refer to credential attributes elements.