genRequest SOAP Response Structure

A genRequest SOAP response typically uses the following format:

<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:BASIC-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/BasicTypes.xsd"
xmlns:SIGN-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Signature"
xmlns:SIGNATURE-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/SignatureTypes.xsd"
<!-- ... Additional namespace declarations -->
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <SIGN-TYPES:genRequestResponse>
      <results xsi:type="SIGNATURE-TYPES:SignatureResults">
        <resultCodes xsi:type="BASIC-TYPES:ResultCodes">
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttribute xsi:type="SIGNATURE-TYPES:SignatureAttributeSet">
          <attributes xsi:type="SIGNATURE-TYPES:SignatureAttribute">
            <attributeID>SIGNFLD_USERID</attributeID>
            <value xsi:type="xsd:string">[userID]</value>
          </attributes>
          <attributes xsi:type="SIGNATURE-TYPES:SignatureAttribute">
            <attributeID>SIGNFLD_DOMAIN</attributeID>
            <value xsi:type="xsd:string">[UserDomain]</value>
          </attributes>
          <attributes xsi:type="SIGNATURE-TYPES:SignatureAttribute">
            <attributeID>SIGNFLD_SERIAL_NO</attributeID>
            <value xsi:type="xsd:string">[SerialNumberOfApplicableDIGIPASS]</value>
          </attributes>
          <attributes xsi:type="SIGNATURE-TYPES:SignatureAttribute">
            <attributeID>SIGNFLD_REQUEST_KEY</attributeID>
            <value xsi:type="xsd:string">1964160839</value>
          </attributes>
          <attributes xsi:type="SIGNATURE-TYPES:SignatureAttribute">
            <attributeID>SIGNFLD_REQUEST_MESSAGE</attributeID>
            <value xsi:type="xsd:string">00C1C3E40F42B83CF9148F387513B695...</value>
          </attributes>
        </resultAttribute>
        <errorStack xsi:type="BASIC-TYPES:ErrorStack"/>
      </results>
    </SIGN-TYPES:genRequestResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The SOAP body element must only contain a single genRequestResponse element. 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, refer to the OneSpan Authentication Server Administrator Reference, Section "Error and Status Codes".

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