The following operations are supported. For a formal definition, please review the Service Description.

• 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
• GetContentIdentifiers
  This method can be used get a list of valid content identifiers.
  
  Input:
  
  • AuthenticationHeader (mandatory)
    The AuthenticationHeader with UserName and PassWord
  • UserIdentifier (mandatory)
    The identifier of the user (format userId@realm)
  • EAN (mandatory)
    European Article Numbering (EAN)
  
  Output:
  
  • ResultCode
    This can be one of the following values
  • -1 = Fatal error
  • 0 = OK
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • ContentIdentifiers
    Contains a list of content identifiers
  • LicenseInformation
    Not used for this call
  • UsageCount
    Not used for this call
• GetFilteredContentIdentifiers
  This method can be used get a list of valid content identifiers for a specified user.
  
  Input:
  
  • AuthenticationHeader (mandatory)
    The AuthenticationHeader with UserName and PassWord
  • UserIdentifier (mandatory)
    The identifier of the user (format userId@realm)
  • ContentIdentifier (optional)
    An identifier of the content
  
  Output:
  
  • ResultCode
    This can be one of the following values
  • -1 = Fatal error
  • 0 = OK
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • ContentIdentifiers
    Contains a list of content identifiers
  • LicenseInformation
    Not used for this call
  • UsageCount
    Not used for this call
• GetLicenseInformation
  This method can be used get the licenses.
  
  Input:
  
  • AuthenticationHeader (mandatory)
    The AuthenticationHeader with UserName and PassWord
  • UserIdentifier (mandatory)
    The identifier of the user (format userId@realm)
  
  Output:
  
  • ResultCode
    This can be one of the following values
  • -1 = Fatal error
  • 0 = OK
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • ContentIdentifiers
    Not used for this call
  • LicenseInformation
    Contains the license information
  • UsageCount
    Not used for this call
• GetLicenses
  Obsolete operation.
  
• GetUsageCount
  This method can be used to get the usage count value.
  
  Input:
  
  • AuthenticationHeader (mandatory)
    The AuthenticationHeader with UserName and PassWord
  • 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
  • 301 = Content was withdrawn
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • 2002 = ContentIdentifier is empty or missing
  • ContentIdentifiers
    Not used for this call
  • LicenseInformation
    Not used for this call
  • UsageCount
    Contains the usage count value
• UpdateUsageCount
  This method can be used to update the usage count value.
  
  Input:
  
  • AuthenticationHeader (mandatory)
    The AuthenticationHeader with UserName and PassWord
  • UserIdentifier (mandatory)
    The identifier of the user (format userId@realm)
  • ContentIdentifier (mandatory)
    The identifier of the content
  • Delta (mandatory)
    The amount to substract.
  
  Output:
  
  • ResultCode
    This can be one of the following values
  • -1 = Fatal error
  • 0 = OK
  • 204 = License unknown
  • 401 = Usage count to low
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • 2002 = ContentIdentifier is empty or missing
  • 2003 = Delta is missing
  • 2004 = Delta must be larger than zero
  • ContentIdentifiers
    Not used for this call
  • LicenseInformation
    Not used for this call
  • UsageCount
    Contains the new value of the usage count
• 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
• VerifyLicenses
  This method can be used to verify the licenses for the user based on the EAN.
  
  Input:
  
  • UserIdentifier (mandatory)
    The identifier of the user (format userId@realm)
  • EAN (mandatory)
    European Article Numbering (EAN)
  
  Output:
  
  • ResultCode
    This can be one of the following values
  • -1 = Fatal error
  • 0 = OK
  • 1000 = AuthenticationHeader is missing
  • 1001 = Authentication failed
  • 2000 = UserIdentifier is empty or missing
  • 2008 = European Articl Numbering (EAN) is missing