License Web Service

License

Click here for a complete list of operations.

Claim

This method can be used to claim a license.

Input:

AuthenticationHeader (mandatory)
The AuthenticationHeader with UserName and PassWord
UserIdentifier (mandatory)
The identifier of the user (format userId@realm)
ActivationCode (mandatory)
The activationcode for the license or product

Output:

ResultCode
This can be one of the following values

-1 = Fatal error
0 = OK
101 = Invalid activation code
102 = Unknown activation code
103 = Activation code has expired
104 = Activation code is already claimed
105 = Max number of claims reached for this activation code
106 = Claim of activationcode failed
201 = License was withdrawn
202 = License type is not supported
1000 = AuthenticationHeader is missing
1001 = Authentication failed
2000 = UserIdentifier is empty or missing
2001 = ActivationCode is empty or missing

ContentIdentifiers
Not used for this call
LicenseInformation
Contains the license information
UsageCount
Not used for this call

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /API/2008/02/License.asmx HTTP/1.1
Host: drm.coreservices.nu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://drm.toegang.nu/API/2008/02/License/Claim"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader UserName="string" PassWord="string" xmlns="http://drm.toegang.nu/API/2008/02/License" />
  </soap:Header>
  <soap:Body>
    <Claim xmlns="http://drm.toegang.nu/API/2008/02/License">
      <UserIdentifier>string</UserIdentifier>
      <ActivationCode>string</ActivationCode>
    </Claim>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ClaimResponse xmlns="http://drm.toegang.nu/API/2008/02/License">
      <Result>
        <ResultCode>int</ResultCode>
        <ContentIdentifiers>
          <item>string</item>
          <item>string</item>
        </ContentIdentifiers>
        <LicenseInformation>
          <item EAN="string" name="string" type="string" isExpired="boolean">
            <startDate>dateTime</startDate>
            <endDate>dateTime</endDate>
            <value>int</value>
          </item>
          <item EAN="string" name="string" type="string" isExpired="boolean">
            <startDate>dateTime</startDate>
            <endDate>dateTime</endDate>
            <value>int</value>
          </item>
        </LicenseInformation>
        <UsageCount>int</UsageCount>
      </Result>
    </ClaimResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /API/2008/02/License.asmx HTTP/1.1
Host: drm.coreservices.nu
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader UserName="string" PassWord="string" xmlns="http://drm.toegang.nu/API/2008/02/License" />
  </soap12:Header>
  <soap12:Body>
    <Claim xmlns="http://drm.toegang.nu/API/2008/02/License">
      <UserIdentifier>string</UserIdentifier>
      <ActivationCode>string</ActivationCode>
    </Claim>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <ClaimResponse xmlns="http://drm.toegang.nu/API/2008/02/License">
      <Result>
        <ResultCode>int</ResultCode>
        <ContentIdentifiers>
          <item>string</item>
          <item>string</item>
        </ContentIdentifiers>
        <LicenseInformation>
          <item EAN="string" name="string" type="string" isExpired="boolean">
            <startDate>dateTime</startDate>
            <endDate>dateTime</endDate>
            <value>int</value>
          </item>
          <item EAN="string" name="string" type="string" isExpired="boolean">
            <startDate>dateTime</startDate>
            <endDate>dateTime</endDate>
            <value>int</value>
          </item>
        </LicenseInformation>
        <UsageCount>int</UsageCount>
      </Result>
    </ClaimResponse>
  </soap12:Body>
</soap12:Envelope>