GET api/Entitlement/{affiliateId}/{supplierRef}?includeParentAndChildren={includeParentAndChildren}
Returns the current entitlement for a given supplier ref. User may only have one current entitlement per supplier ref.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| affiliateId |
The unique identifier of the affiliate. |
integer |
Required |
| supplierRef |
The purchase order item supplier reference. |
string |
Required |
| includeParentAndChildren |
True if parent-child relations should be included in media item DTO. |
boolean |
Default value is False |
| v |
The requested API version |
string |
Default value is 2.0 |
Body Parameters
None.
Response Information
Resource Description
Returns the current entitlement for a given supplier ref. User may only have one current entitlement per supplier ref.
FilmFlex.Platform.Common.Super.Model.V2.EntitlementDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| EntitlementType |
The type of entitlement acquired |
FilmFlex.Platform.Common.Super.Model.V2.EntitlementTypeDTO |
None. |
| RentalExpiryTime |
The date and time when this rental will expire |
date |
None. |
| LastPlayPosition |
The last play position for the current entitlement. |
time interval |
None. |
| RegisteredRegisteredDevice |
For persistent licenses, the device that the entitlement was made against |
FilmFlex.Platform.Common.API.Contracts.V2.RegisteredDeviceDTO |
None. |
| TransientLicenceIssued |
If not Persistent License issued |
boolean |
None. |
| MediaItem |
The media item V2 associated with this entitlement |
FilmFlex.Platform.Common.API.Contracts.V2.MediaItemMidiDTO |
None. |
| MediaAssets |
Metia assets colletion associated with this entitlement |
Collection of FilmFlex.Platform.Common.API.Contracts.V2.MediaAssetDTO |
None. |
| Children |
Child entitlements |
Collection of FilmFlex.Platform.Common.Super.Model.V2.EntitlementDTO |
None. |
| Parent |
Parent entitlement |
FilmFlex.Platform.Common.Super.Model.V2.EntitlementDTO |
None. |
| Hide |
Hide from Top level entitlement view. e.g. child entitlement |
boolean |
None. |
| PoCreatedDate | date |
None. |
|
| Id |
Purchase Order Item Id |
integer |
None. |
| PurchaseOrderId |
The associated Purchase Order Id |
integer |
None. |
| OfferId |
FK of offer that is/was being purchased |
integer |
None. |
| UnitPrice |
unit price that the user is paying |
decimal number |
None. |
| SupplierRef |
Supplier Reference for the media item |
string |
None. |
| TimeOfFirstPlay |
The date and time when the first DRM licence was issued for this rental |
date |
None. |
| RentalTime |
Total time (in days) from the time the order was created until the rental ends whether watched or not |
integer |
None. |
| ViewTime |
Total time (in hours) from first play to when the rental expires |
integer |
None. |
| Title |
Film title. For historical records - film may no longer exist on the service |
string |
None. |
| BbfcRating |
BBFC rating. For historical records - film may no longer exist on the service |
string |
None. |
| Duration |
Film duration. For historical records - film may no longer exist on the service |
integer |
None. |
| Deleted |
Deleted flag. Item may be flagged as deleted, but will remain in the db |
boolean |
None. |
| RequiresPreRoll |
Film requires pre-roll ad when played. |
boolean |
None. |
| PersistentLicenseIssued |
Persistent License Issued |
boolean |
None. |
| IsDtr |
Purchase supports DTR |
boolean |
None. |
| SupportedDevices | string |
None. |
|
| ShippingIds | string |
None. |
|
| DrmProfile |
The drm profile to apply when delivering a license |
string |
None. |
| LicenseAcknowledged |
License Acknowledged |
boolean |
None. |
| EntitlementTypeId |
Entitlement Type Id |
integer |
None. |
| CreatedDate |
Date and time that the parent Purchase Order Item was created. |
date |
None. |
| TimeUserFirstStreamed |
Date and time that the user first streamed this media item. |
date |
None. |
| TimeUserFirstDownloaded |
Date and time that the user first downloaded this media item. |
date |
None. |
| DeviceIdOfFirstPlay |
ID of the device on which the user first viewed this media item, if known. |
integer |
None. |
| PaymentProvider |
Payment Provider (from parent Purchase Order) |
string |
None. |
| PaymentProviderTransactionId |
Payment Provider Transaction Id (from parent Purchase Order) |
string |
None. |
| Inherited |
Gets or sets a value indicating whether this is inherited. |
boolean |
None. |