EntitlementService
Web services used to perform productization and the discovery of policies, affiliates, and DRM-related information.
Endpoint Metadata
- Namespace: http://opencase.extend.com/webservices/entitlement
- Endpoint Name: EntitlementWebService
- Endpoint Address: http(s)://{VMS URL}/ContentManager/webservices/entitlement-service
The following methods are available on this endpoint:
Adds lifecycle metadata to product.
Input Parameters
name |
type |
description |
productPk |
integer |
A product's primary key. |
productLifecycleMetadata |
ProductLifecycleMetadata
|
A product lifecycle metadata related to product specified by productPk. |
Faults
name |
description |
EntitlementParameterFault |
If a product or productLifecycleMetadata specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to add lifecycle metadata to product. |
Adds lifecycle metadata to product.
Input Parameters
name |
type |
description |
productUuid |
string |
A product's UUID. |
productLifecycleMetadata |
ProductLifecycleMetadata
|
A product lifecycle metadata related to product specified by productUuid. |
Faults
name |
description |
EntitlementParameterFault |
If a product or productLifecycleMetadata specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to add lifecycle metadata to product. |
Designates a specified set of products to a specified list of affiliates.
Input Parameters
name |
type |
description |
productPks |
integer[] |
The list of product primary keys to be designated to the affiliates. |
affiliatePks |
integer[] |
The list of affiliates primary keys that the products will be designated to. |
Faults
name |
description |
EntitlementParameterFault |
If a product or affiliate specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to save the product with the designated affiliates list. |
Designates a specified set of products to a specified list of affiliates.
Input Parameters
name |
type |
description |
productUuids |
string[] |
The list of product UUIDs to be designated to the affiliates. |
affiliateUuids |
string[] |
The list of affiliates UUIDs that the products will be designated to. |
Faults
name |
description |
EntitlementParameterFault |
If a product or affiliate specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to save the product with the designated affiliates list. |
Filters productUUIDs using filter chain.
Input Parameters
name |
type |
description |
productUUIDs |
string |
which will be filtered. |
dataBeans |
list<abstractFilterData>
|
(no documentation provided) |
Return Value
type |
description |
list |
filtered products. |
Faults
name |
description |
EntitlementWebserviceFault |
If an error occurred when executing filterProducts. |
Returns a list of all active policies.
Return Value
Faults
name |
description |
EntitlementWebserviceFault |
If the activate policy list cannot be returned for any reason. |
Finds and returns an affiliate with a specific primary key.
Input Parameters
name |
type |
description |
affiliatePk |
integer |
The primary key of the affiliate to retrieve. |
Return Value
type |
description |
Affiliate
|
The affiliate matching the specified primary key. If no affiliate match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified affiliatePk is invalid. |
EntitlementWebserviceFault |
If find affiliate by primary key failed. |
Finds and returns an affiliate with a specific uuid.
Input Parameters
name |
type |
description |
uuid |
string |
The uuid field of the affiliate to retrieve. |
Return Value
type |
description |
Affiliate
|
The affiliate matching the specified uuid. If no affiliate match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified uuid is invalid. |
EntitlementWebserviceFault |
If the affiliate or a null value cannot be returned for any reason. |
Returns a list of all active affiliates.
Return Value
Faults
name |
description |
EntitlementWebserviceFault |
If the active affiliate list cannot be returned for any reason. |
Retrieves a list of all the currencies available, from OCME_CURRENCY.
Return Value
type |
description |
list<Currency>
|
a list of currencies, returns an empty list if no currencies are found |
Faults
name |
description |
EntitlementWebserviceFault |
If the currency list cannot be returned for any reason |
Returns a list of all DrmTypes regardless of whether or not they are active. DrmTypes that are included in the InteroperableDomain willNOT appear in the list but will appear as children of that DrmType.
Return Value
type |
description |
list<DrmType>
|
A list of ALL DrmTypes except for those in the InteroperableDomain. |
Faults
name |
description |
EntitlementWebserviceFault |
If the DrmType list cannot be returned for any reason. |
Finds and returns a policy with a specific policyPk.
Input Parameters
name |
type |
description |
policyPk |
integer |
The primary key of the policy to retrieve. |
Return Value
type |
description |
Policy
|
The policy matching the specified policyPk. If no policy match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified policyPk is invalid. |
EntitlementWebserviceFault |
If the policy or null cannot be returned for any non-parameter reason. |
Finds and returns a policy with a specific uuid.
Input Parameters
name |
type |
description |
uuid |
string |
The uuid of the policy to retrieve. |
Return Value
type |
description |
Policy
|
The policy matching the specified uuid. If no policy match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified uuid is invalid. |
EntitlementWebserviceFault |
If the policy or null cannot be returned for any non-parameter reason. |
Finds a product with a specific externalID. Since the externalID field is unique, this method returns one product.
Input Parameters
name |
type |
description |
externalID |
string |
The externalID field of the product to retrieve |
Return Value
type |
description |
Product
|
A product matching the specified externalID. If no product is found, a null value is returned. |
Faults
name |
description |
EntitlementParameterFault |
Thrown if the specified parameter is null or empty |
EntitlementWebserviceFault |
Thrown if unexpected application exception occurs. |
Finds and returns a product with a specific primary key.
Input Parameters
name |
type |
description |
productPk |
integer |
The primary key field of the product to retrieve. |
Return Value
type |
description |
Product
|
The product matching the specified primary key. If no product match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified productPk is invalid. |
EntitlementWebserviceFault |
If find affiliate by primary key failed. |
Finds and returns a product with a specific uuid.
Input Parameters
name |
type |
description |
uuid |
string |
The uuid field of the product to retrieve. |
Return Value
type |
description |
Product
|
The product matching the specified uuid. If no product match is found, null is returned. |
Faults
name |
description |
EntitlementParameterFault |
If the specified uuid is invalid. |
EntitlementWebserviceFault |
If the product or null cannot be returned for any reason. |
Find products that are related to the specific bundle externalId.
Input Parameters
name |
type |
description |
bundleExternalId |
string |
The External Id of the bundle. |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of products that contain the referenced bundle. |
Faults
name |
description |
EntitlementParameterFault |
If the specified bundleExternalId is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
Find products that are related to the specific bundle primary key.
Input Parameters
name |
type |
description |
bundlePk |
integer |
The primary key of the bundle. |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of products that contain the referenced bundle. |
Faults
name |
description |
EntitlementParameterFault |
If the specified bundle primary key is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
Find products that are related to the specific bundle uuid and the products with the same stationId of physical asset within the TSTVbundle with given bundleUuid
Input Parameters
name |
type |
description |
bundleUuid |
string |
The uuid of the bundle. |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of products that contain the referenced bundle. |
Faults
name |
description |
EntitlementParameterFault |
If the specified uuid is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
Find subscription products by TSTV subscription bundleUuid
Input Parameters
name |
type |
description |
releaseUrl |
string |
(no documentation provided) |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of subscription products that contain the referenced subscription code. |
Faults
name |
description |
EntitlementParameterFault |
If the specified release url is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
Find subscription products by subscription code based bundle uuid
Input Parameters
name |
type |
description |
bundleUuid |
string |
Subscription bundle uuid |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of subscription products that contain the referenced subscription code. |
Faults
name |
description |
EntitlementParameterFault |
If the specified uuid is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
/** Find subscription products by bundle release url
Input Parameters
name |
type |
description |
releaseUrl |
string |
(no documentation provided) |
affiliateUuid |
string |
The uuid of the affiliate. |
Return Value
type |
description |
list<Product>
|
a list of subscription products that contain the referenced release url. |
Faults
name |
description |
EntitlementParameterFault |
If the specified release url is invalid. |
EntitlementWebserviceFault |
If the product list or null cannot be returned for any reason. |
Returns product's XML for specified Pk.
Input Parameters
name |
type |
description |
productPk |
integer |
The primary key of the product. |
Return Value
type |
description |
string |
a String with the XML of the referenced Product. |
Faults
name |
description |
EntitlementParameterFault |
If the specified productPk is invalid. |
EntitlementWebserviceFault |
If the XML representation of a product cannot be returned for any reason. |
Method to retrieve an XML representation of a product.
Input Parameters
name |
type |
description |
productUuid |
string |
The Uuid of the product. |
Return Value
type |
description |
string |
a String with the XML of the referenced Product. |
Faults
name |
description |
EntitlementParameterFault |
If the specified productUuid is invalid. |
EntitlementWebserviceFault |
If the XML representation of a product cannot be returned for any reason. |
Creates and returns a list of products for each bundle/policy combination. The total number of products created is m * n, where m is thenumber of bundles and n is the number of policies.
Input Parameters
name |
type |
description |
bundlePks |
integer[] |
An array of primary keys of the bundles to be productized. |
policyPks |
integer[] |
An array of primary keys of the policies to be used for productizing. |
Return Value
type |
description |
list<Product>
|
A list of products created by applying policies to bundles. |
Faults
name |
description |
EntitlementParameterFault |
If either the bundlePk or policyPk parameters are invalid. |
EntitlementWebserviceFault |
If any exception occurs other than those thrown relating to parameters or inactive bundles or policies. |
NotProductizableFault |
If any of the bundles or policies are inactive. |
Creates and returns a list of products for each bundle/policy combination. The total number of products created is m * n, where m is thenumber of bundles and n is the number of policies. Policies are specified by uuids.
Input Parameters
name |
type |
description |
bundlePks |
integer[] |
An array of primary keys of the bundles to be productized. |
policyUuids |
string[] |
An array of uuids of the policies to be used for productizing. |
Return Value
type |
description |
list<Product>
|
A list of products created by applying policies to bundles. |
Faults
name |
description |
EntitlementParameterFault |
If either the bundlePk or policyUuid parameters are invalid. |
EntitlementWebserviceFault |
If any exception occurs other than those thrown relating to parameters or inactive bundles or policies. |
NotProductizableFault |
If any of the bundles or policies are inactive. |
Removes lifecycle metadata by productLifecycleMetadataPk.
Input Parameters
name |
type |
description |
productLifecycleMetadataPk |
integer |
A product lifecycle metadata's primary key to be removed from product. |
Faults
name |
description |
EntitlementParameterFault |
If a lifecycle metadata specified cannot be found. |
EntitlementWebserviceFault |
If an error occurred executing remove lifecycle metadata. |
Retrieves a Product and Component for use in processing a license request and then checks to see if the component belongs to the bundleassociated to the product.
Input Parameters
name |
type |
description |
productUuid |
string |
The uuid field of the product to retrieve. |
componentUuid |
string |
The uuid field of the component to retrieve. Only one of this or contentId should be passed in. If both are present componentUuid takes precedence. |
contentID |
string |
The contentId of a PhysicalAsset to retrieve. |
onlyDirectAncestor |
boolean |
Used when performing the component to bundle check. If "True" it is successful only if the component is a direct child of the bundle, if "False" it is successful if the component is a descendant of the bundle in any way. |
Return Value
type |
description |
LicenseRequestInfo
|
A LicenseRequestInfo object containing the requested Product and Component. |
Faults
name |
description |
ComponentNotInBundleFault |
If Component with specified uuid is not contained in bundle with specified pk. |
EntitlementParameterFault |
If failed to find product or component by uuid. |
EntitlementWebserviceFault |
If an error occurred executing bundle contains component check. |
Undesignates a specified set of affiliates from a specified product.
Input Parameters
name |
type |
description |
productPk |
integer |
A product's primary key to be designated to the affiliates. |
affiliatePks |
integer[] |
The list of affiliates primary keys that the products will be designated to. |
Faults
name |
description |
EntitlementParameterFault |
If a product or affiliate specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to save the product with the designated affiliates list. |
Undesignates a specified set of affiliates from a specified product.
Input Parameters
name |
type |
description |
productUuid |
string |
A product's UUID to be designated to the affiliates. |
affiliateUuids |
string[] |
The list of affiliates UUIDs that the products will be designated to. |
Faults
name |
description |
EntitlementParameterFault |
If a product or affiliate specified cannot be found. |
EntitlementWebserviceFault |
If an error occurs when attempting to save the product with the designated affiliates list. |
Updates a specified product.
The following incoming parameters must match the values of the existing component:
Product Primary Key Product Bundle Product UUID
Input Parameters
name |
type |
description |
productToUpdate |
Product
|
The product that will be updated. |
Return Value
type |
description |
Product
|
An updated product. |
Faults
name |
description |
EntitlementWebserviceFault |
If any non-parameter exception occurs that has prevented the product from being updated. |