Machine-Readable Usage Instructions and Pricing

The API returns machine-readable usage instructions and pricing as a JSON representation of RightsML, which is based on ODRL.

ODRL Elements

If pricing=true is specified in the request, the following ODRL elements are returned for each content item:

Top-Level Properties

• policy. The ODRL Policy, which specifies the permitted or prohibited Actions that may be performed on the specified Assets.
  • policytype. The Policy type that determines how the policy is to be interpreted. "Set" is currently the only supported value.
  • policyid. The unique Policy identifier.
  • "permissions" OR "prohibitions". A Permission allows a certain Action to be performed on a specified Asset (for example, download and use the content item). A Prohibition forbids the action.

Permission/Prohibition Descriptive Properties

• target. The content item ID to which the Permission or Prohibition applies.
• action. Indicates permitted or prohibited usage.
• assigner. The URL to the assigner's website.
• constraints. Indicates limitations to the permitted usage; for example, "editorial use only."
  • name. Specifies the type of constraint, such as "purpose."
  • operator. Specifies how to evaluate the constraint; for example, "equal to."
  • rightoperand. The value required to meet the constraint; for example, "editorial use only."
• duties. Expresses a Duty that must be satisfied in order to exercise the Permission.

Duty Descriptive Properties

• action. Identifies the specific action that must be performed to carry out the Duty; for example, "compensate" (pay a certain amount) or "reviewPolicy" (refer to usage terms).

   

• constraints. Indicates a condition of the Duty; for example, that a specific amount must be paid.
  • name. Specifies the type of constraint, such as "the amount to pay."
  • operator. Specifies how to evaluate the constraint; for example, "equal to."
  • rightoperand. The value required to meet the constraint; for example, the charge amount.
  • rightoperanddatatype. The XML schema data type of the "right operand" value; for example, "decimal."
  • rightoperandunit. The unit used in expressing the "right operand" value; for example, the currency of the charge.

Examples

The following examples show the machine-readable use and pricing information returned by the API for each of the pricing scenarios.

Included In Your Plan (Choice)

In this example:

• Lines 4-6 indicate a permission to download and use the specified content item (included in your Choice plan).

• Lines 12, 15 and 17 indicate the Choice tier that will be used by your plan's meter to calculate the payment amount.

• Lines 12 and 21 indicate that you must review the human-readable special restrictions in the usage terms.

Included In Your Plan (Other Plans)

In this example:

• Lines 4-6 indicate a permission to download and use the specified content item included in your plan (this download will be deducted from the number of available downloads).

• Lines 12 and 13 indicate that you must review the human-readable special restrictions in the usage terms.

Not Included In Your Plan (Extra Charge, All Plans)

In this example:

• Lines 4-6 indicate a permission to download and use the specified content item once the extra charge amount is paid.

• Lines 12, 15, 17 and 19 indicate the extra charge amount that will be paid in the specified currency. For currency values, refer to ISO 4217.

• Lines 12 and 21 indicate that you must review the human-readable special restrictions in the usage terms.

Not Included In Your Plan (Contact Licensing, All Plans)

In this example, lines 4-6 indicate that you are prohibited from downloading or using the specified content item. It is not included in your plan; you can contact your licensing representative to learn more about license rights.