+813-444-3589+44 118 328 3220+49-231-976765-0 | Contact us

License

The license resource represents licenses used for restricting access to content. Every piece of content is associated with at least one license. 

What can you do with License?

The FlickRocket API lets you do the following with the license resource. More detailed versions of these general actions may be available:

GET /api/licenses.json

Receive a list of all licenses defined for the company.

GET /api/licenses/#{token}.json

Receive a single license identified via token (License ID).

License Properties

allow_play
"allow_play": 1

If set o one this license allows view/playback (vs.burning, export) of content.

annual_concurrent_devices
"annual_concurrent_devices": 1

The maximum number of concurrent devices allowed per year.

annual_downloads
"annual_downloads": 2

The maximum number of downloads per year.

annual_export
"annual_export": 0

The maximum number of allowed exports.

assignment
"assignment": 2

Indicates that this is a shared general license or a company specific license.

burn_play
"burn_play": 100

The count for the licenses primary burn/export/print action

company_id
"company_id": 1000

The company_id of the company to which this license belongs.

copp_aps
"copp_aps": 0

0: Certified Output Protection Protocol - Analog Protection System disabled

1: Certified Output Protection Protocol - Analog Protection System enabled

copp_cgms
"copp_cgms": 0

0: Certified Output Protection Protocol - Copy Generation Management System disabled

1: Certified Output Protection Protocol - Copy Generation Management System enabled

copp_hdcp
"copp_hdcp": 0

0: Certified Output Protection Protocol - High Bandwidth Digital Copy Protection System disabled

1: Certified Output Protection Protocol - High Bandwidth Digital Copy Protection System enabled

copy_prot_level_analog
"copy_prot_level_analog": 0

Analog copy protection level:

0: No copy protection

100: CGMS-A Copy Once

200: CGMS-A Copy Never

300: CGMS-A Copy Never + APS Bit 1 active

400: CGMS-A Copy Never + APS Bit 2 active

500: CGMS-A Copy Never + APS Bit 1+2 active

copy_prot_level_digital
"copy_prot_level_digital": 100

Digital copy protection level:

0: No copy protection

100: SecureBurn

110: SecureBurn enhanced security

200: SecureBurn + Recordable CSS

300: Enforce  SecureBurn + Recordable CSS

created_at
 "created_at": "2009-01-28T14:18:39"

Date and time the license was created.

created_by_user_id
"created_by_user_id": 1004

User ID of the user who created the license.

delete_on_clock_rollback
"delete_on_clock_rollback": 0

0: Clock rollback is not checked

1: The license is deleted if a clock rollback is detected. Even after setting the time back to normal the content cannot be accessed.

disable_on_clock_rollback
"disable_on_clock_rollback": 1

0: Clock rollback is not checked

1:The license is temporary invalidated in case of a clock rollback. It becomes accessible again after the time back to normal.

drm
"drm": 1

0: No DRM control. All DRM related definitions in the license have no effect.

1: DRM controlled as defined by the other fields.

expiration_date
"expiration_date": null

This date is used to set the license expiration to a certain date.

expire_after_acquisition
"expire_after_acquisition": 0

0: The license does not expire based on this condition.

1: The license expires independent of usage. The number is the time allowed bfore the license expires after it is issued (after aquisition) defined by the expire_after_acquisition_mode field.

expire_after_acquisition_mode
"expire_after_acquisition_mode": 0

0: Stunden

1: Tage

2: Monate

expire_after_first_use
"expire_after_first_use": 0

0: The license does not expire based on this condition.

1: The license expires after usage. The number is the time allowed bfore the license expires after it is fist used defined by the expire_after_first_use_mode field.

expire_after_first_use_mode
"expire_after_first_use_mode": 0

0: Stunden

1: Tage

2: Monate

export_epub
"export_epub": 0

0: Exporting the content as ePub (no DRM) is not allowed

1: Exporting the content as ePub (no DRM) is allowed

export_mp3
"export_mp3": 0

0: Exporting the content as MP3 (no DRM) is not allowed

1: Exporting the content as MP3 (no DRM) is allowed

export_pdf_print
"export_pdf_print": null

0: Printing PDF content is not allowed. 

1: Printing PDF content is allowed. The number of allowed pages per print is defined by the burn_play field

id
"id": 27

The unique ID identifying this license

locales
locales:
{
"description": "This license allows for 100 burns in addition to digital access"

The localized description of the license (e.g. used in the shop)

"id": 142

ID identifying this license localization in the license

"language_id": 1

Identifies the language of this localization

"name": "License for 100 protected DVD burns"

The localized name of this license (e.g. displayed in the shop for selection)
}

name
"name": "License for 100 protected DVD burns"

The name of this license (e.g. displayed in the admin interface)

physical
"physical": -1

Set to1 for physical products. 

physical_weight
"physical_weight": null 

The weight of the physical product in the weight unit defined by "physical_weight_type". 

physical_weight_type
"physical_weight_type": null

The weight unit in which the weight is specified

0: gram 

1: lbs 

play_prot_level_analog
"play_prot_level_analog": 0

0: No copy protection

100: CGMS-A Copy Once

200: CGMS-A Copy Never

300: CGMS-A Copy Never + APS Bit 1 active

400: CGMS-A Copy Never + APS Bit 2 active

500: CGMS-A Copy Never + APS Bit 1+2 active

play_prot_level_digital
"play_prot_level_digital": 100

0: No protection

100: Use HDCP (if available) and allow AirPlay

150: Use HDCP (if available) and disable AirPlay

200: Enforce HDCP

restriction_country
"restriction_country": []

{

"id": 13590

ID identifying this restriction in the license

"country_id": 29

ID identifying the country in which the content is allowed to be sold 

}

restriction_dvd_region
"restriction_dvd_region": []

{

"id": 21

ID identifying this DVD region restriction in the license

"dvd_region": 2

Number of the DVD Region allowed (see DVD-Video documentation for details about region coding)

}

restriction_video_norm

"restriction_video_norm":

{
"id": 0

ID for this restriction within the license

"norm": 0

0: Allow NTSC countries

1: Allow PAL countries

}

total_concurrent_devices
"total_concurrent_devices": 1

The maximum total number of concurrent devices

total_downloads
"total_downloads": 2

Total maximum total number of downloads

total_export
"total_export": 1

Total number of allowed exports

type
"type": 1

0: Content license

1: Software license

2: Physical + Software license

3: Physical + Content license

valid
"valid": 1

0: Indicates an invalid license (e.g. because it has been deleted)

1: Indicates a valid license

Get all licenses

GET /api/licenses.json
View Response

Receive a single License identified by License ID token

GET /api/licenses/#{token}.json
View Response

Receive a count of all licenses

GET /api/licenses/count.json
View Response