provisioningExecute SOAP Response Structure

A provisioningExecute SOAP response typically uses the following format:

<?xmlversion="1.0"encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xop="http://www.w3.org/2004/08/xop/include"
xmlns:BASIC-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/BasicTypes.xsd"
xmlns:PROVISIONING-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/ProvisioningTypes.xsd"
xmlns:PROV-TYPES="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Provisioning">
  <SOAP-ENV:Body>
    <PROV-TYPES:provisioningExecuteResponse>
      <results>
        <resultCodes>
          <returnCodeEnum>RET_SUCCESS</returnCodeEnum>
          <statusCodeEnum>STAT_SUCCESS</statusCodeEnum>
          <returnCode>0</returnCode>
          <statusCode>0</statusCode>
        </resultCodes>
        <resultAttribute>
          <attributes>
            <valuexsi:type="xsd:string">testuser</value>
            <attributeID>PROVFLD_USERID</attributeID>
          </attributes>
          <attributes>
            <valuexsi:type="xsd:string">master</value>
            <attributeID>PROVFLD_DOMAIN</attributeID>
          </attributes>
          <attributes>
            <valuexsi:type="xsd:string"/>
            <attributeID>PROVFLD_ORGANIZATIONAL_UNIT</attributeID>
          </attributes>
          <attributes>
            <valuexsi:type="xsd:string">VDS1000140</value>
            <attributeID>PROVFLD_SERIAL_NO</attributeID>
          </attributes>
          <attributes>
            <attributeOptions>
              <masked>true</masked>
            </attributeOptions>
            <valuexsi:type="xsd:string">3808019401035644530210101...</value>
            <attributeID>PROVFLD_ACTIVATION_CODE</attributeID>
          </attributes>
        </resultAttribute>
        <errorStack/>
      </results>
    </PROV-TYPES:provisioningExecuteResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The SOAP body element should only contain a provisioningExecuteResponse element (line 12). The provisioningExecuteResponse element always contains a results 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.

In this case, the resultattribute element is used to refer to provisioning attributes elements.