GET api/License/RequestLicense/{affiliateId}?deviceId={deviceId}&keyId={keyId}&persistentLicenseRequested={persistentLicenseRequested}&deviceTypeDescription={deviceTypeDescription}

Used by the Licensor to request a license. Validates whether a PlayReady License should be issued. This call was known as 'PermittedLicense' in the Ioko UI Service.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

integer

Required

deviceId

The unique device Id

globally unique identifier

Required

keyId

The Media Asset Encryption Key

globally unique identifier

Required

persistentLicenseRequested

Is a persistent license being requested

boolean

Required

deviceTypeDescription

The device type

string

Required

v

The requested API version

string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Used by the Licensor to request a license. Validates whether a PlayReady License should be issued. This call was known as 'PermittedLicense' in the Ioko UI Service.

FilmFlex.Platform.Common.API.Contracts.V1.LicenseDTO
NameDescriptionTypeAdditional information
EntitlementId

integer

None.

DrmProfile

string

None.

ExpirationDate

date

None.

FirstPlayExpiration

time interval

None.

Response Formats

application/json, text/json

Sample:
{
  "EntitlementId": 1,
  "DrmProfile": "sample string 2",
  "ExpirationDate": "2025-09-04T07:12:38.316892+00:00",
  "FirstPlayExpiration": "00:00:00.1234567"
}