genRequest SOAP Request Structure

Prev Next

A genRequest SOAP request typically uses the following format:

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sig="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Signature"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Header/>
  <soapenv:Body>
    <sig:genRequest>
      <attributeSet>
        <attributes>
          <attributeID>SIGNFLD_COMPONENT_TYPE</attributeID>
          <value xsi:type="xsd:string">[ClientApplication]</value>
        </attributes>
        <attributes>
          <attributeID>SIGNFLD_USERID</attributeID>
          <value xsi:type="xsd:string">[UserID]</value>
        </attributes>
        <attributes>
          <attributeID>SIGNFLD_DOMAIN</attributeID>
          <value xsi:type="xsd:string">[UserDomain]</value>
        </attributes>
        <!--Additional attributes elements may follow-->
      </attributeSet>
      <dataFieldList>
        <dataField>
          <key>[key1]</key>
          <value>[value1]</value>
        </dataField>
        <!--Additional dataField elements may follow-->
      </dataFieldList>
    </sig:genRequest>
  </soapenv:Body>
</soapenv:Envelope>

The SOAP body element must only contain a single genRequest element. This element is defined in the namespace sig. Therefore, the sig namespace needs to be declared in the Envelope element as an attribute.

A valid genRequest request must follow these additional rules:

  • The genRequest element must contain one attributeSet.
  • The attributeSet element must contain the minimum number of required attribute elements.
  • Either one dataFieldList element or an attribute element containing an attributeID element with the value SIGNFLD_REQUEST_BODY must exist.
  • The dataFieldList element must contain at least one dataField element.