License Web Service

License

Click here for a complete list of operations.

Verify

This method can be used to verify the license is valid for the user based on the content identifier.

Input:

UserIdentifier (mandatory)
The identifier of the user (format userId@realm)
ContentIdentifier (mandatory)
The identifier of the content

Output:

ResultCode
This can be one of the following values

-1 = Fatal error
0 = OK
201 = License was withdrawn
203 = License has expired
204 = License unknown
205 = License not started
301 = Content was withdrawn
401 = Usage count to low
2000 = UserIdentifier is empty or missing
2002 = ContentIdentifier 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/Verify"

<?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>
    <Verify xmlns="http://drm.toegang.nu/API/2008/02/License">
      <UserIdentifier>string</UserIdentifier>
      <ContentIdentifier>string</ContentIdentifier>
    </Verify>
  </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>
    <VerifyResponse 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>
    </VerifyResponse>
  </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:Body>
    <Verify xmlns="http://drm.toegang.nu/API/2008/02/License">
      <UserIdentifier>string</UserIdentifier>
      <ContentIdentifier>string</ContentIdentifier>
    </Verify>
  </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>
    <VerifyResponse 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>
    </VerifyResponse>
  </soap12:Body>
</soap12:Envelope>