GET api/Entitlement/Current/{affiliateId}?includeMediaItem={includeMediaItem}&skip={skip}&take={take}

Returns the authenticated users current entitlements

Request Information

URI Parameters

Name	Description	Type	Additional information
affiliateId		integer	Required
includeMediaItem		boolean	Default value is False
skip		integer	Default value is 0
take		integer	Default value is 10
v	The requested API version	string	Required Default value is 1

Body Parameters

None.

Response Information

Resource Description

Returns the authenticated users current entitlements

Collection of FilmFlex.Platform.Common.Super.Model.V1.EntitlementDTO

Name	Description	Type	Additional information
EntitlementType	The type of entitlement acquired	FilmFlex.Platform.Common.Super.Model.V1.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.V1.RegisteredDeviceDTO	None.
TransientLicenceIssued	If not Persistent License issued	boolean	None.
MediaItem	The media item associated with this entitlement	FilmFlex.Platform.Common.API.Contracts.V1.MediaItemMidiDTO	None.
MediaAssets	Metia assets colletion associated with this entitlement	Collection of FilmFlex.Platform.Common.API.Contracts.V1.MediaAssetDTO	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.
DrmProfile	The drm profile to apply when delivering a license	string	None.
LicenseAcknowledged		boolean	None.
EntitlementTypeId		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EntitlementType": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "RentalExpiryTime": "2025-09-04T07:14:46.3678649+00:00",
    "LastPlayPosition": "00:00:00.1234567",
    "RegisteredRegisteredDevice": {
      "Id": 1,
      "DeviceTypeId": 2,
      "DeviceTypeName": "sample string 3",
      "DeviceName": "sample string 4",
      "UserId": "62722f58-7cec-4f55-a3ad-a6fa3bd6dba8",
      "UpdatedDate": "2025-09-04T07:14:46.3678649+00:00",
      "IsActive": true,
      "ClientId": "42d7f0bc-505f-4f5c-82c5-cd49d90d8d52",
      "CanDelete": true
    },
    "TransientLicenceIssued": true,
    "MediaItem": {
      "SupplierReference": "sample string 1",
      "Title": "sample string 2",
      "SortTitle": "sample string 3",
      "TitleKeywords": "sample string 4",
      "ReleaseYear": 5,
      "Certificate": "sample string 6",
      "Duration": "sample string 7",
      "Cast": [
        {
          "Type": "sample string 1",
          "FullName": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "FullName": "sample string 2"
        }
      ],
      "NewsletterSynopsis": "sample string 8",
      "TrailerUri": "sample string 9",
      "FurnitureBaseUrl": "sample string 10",
      "Furniture": [
        {
          "Uri": "sample string 1",
          "FurnitureType": "sample string 2"
        },
        {
          "Uri": "sample string 1",
          "FurnitureType": "sample string 2"
        }
      ],
      "ExternalIdentifiers": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Offers": [
        {
          "Id": 1,
          "StartAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "EndAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "Price": 4.0,
          "Currency": "sample string 5",
          "RentalTime": 1,
          "ViewTime": 1,
          "AssetTypeId": "sample string 6",
          "SupportedDevices": [
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            },
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            }
          ],
          "OfferType": "sample string 7"
        },
        {
          "Id": 1,
          "StartAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "EndAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "Price": 4.0,
          "Currency": "sample string 5",
          "RentalTime": 1,
          "ViewTime": 1,
          "AssetTypeId": "sample string 6",
          "SupportedDevices": [
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            },
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            }
          ],
          "OfferType": "sample string 7"
        }
      ],
      "AudioDescriptionAvailable": true
    },
    "MediaAssets": [
      {
        "AssetType": "sample string 1",
        "MaterialTitle": "sample string 2",
        "MediaUri": "http://webapihelppage3.com",
        "KeyId": "sample string 4",
        "AspectRatio": "sample string 5",
        "TranscodeTypeId": 6,
        "TranscodeTypeDescription": "sample string 7"
      },
      {
        "AssetType": "sample string 1",
        "MaterialTitle": "sample string 2",
        "MediaUri": "http://webapihelppage3.com",
        "KeyId": "sample string 4",
        "AspectRatio": "sample string 5",
        "TranscodeTypeId": 6,
        "TranscodeTypeDescription": "sample string 7"
      }
    ],
    "Id": 2,
    "PurchaseOrderId": 3,
    "OfferId": 4,
    "UnitPrice": 5.0,
    "SupplierRef": "sample string 6",
    "TimeOfFirstPlay": "2025-09-04T07:14:46.3678649+00:00",
    "RentalTime": 1,
    "ViewTime": 1,
    "Title": "sample string 7",
    "BbfcRating": "sample string 8",
    "Duration": 9,
    "Deleted": true,
    "RequiresPreRoll": true,
    "PersistentLicenseIssued": true,
    "IsDtr": true,
    "SupportedDevices": "sample string 12",
    "DrmProfile": "sample string 13",
    "LicenseAcknowledged": true,
    "EntitlementTypeId": 15
  },
  {
    "EntitlementType": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "RentalExpiryTime": "2025-09-04T07:14:46.3678649+00:00",
    "LastPlayPosition": "00:00:00.1234567",
    "RegisteredRegisteredDevice": {
      "Id": 1,
      "DeviceTypeId": 2,
      "DeviceTypeName": "sample string 3",
      "DeviceName": "sample string 4",
      "UserId": "62722f58-7cec-4f55-a3ad-a6fa3bd6dba8",
      "UpdatedDate": "2025-09-04T07:14:46.3678649+00:00",
      "IsActive": true,
      "ClientId": "42d7f0bc-505f-4f5c-82c5-cd49d90d8d52",
      "CanDelete": true
    },
    "TransientLicenceIssued": true,
    "MediaItem": {
      "SupplierReference": "sample string 1",
      "Title": "sample string 2",
      "SortTitle": "sample string 3",
      "TitleKeywords": "sample string 4",
      "ReleaseYear": 5,
      "Certificate": "sample string 6",
      "Duration": "sample string 7",
      "Cast": [
        {
          "Type": "sample string 1",
          "FullName": "sample string 2"
        },
        {
          "Type": "sample string 1",
          "FullName": "sample string 2"
        }
      ],
      "NewsletterSynopsis": "sample string 8",
      "TrailerUri": "sample string 9",
      "FurnitureBaseUrl": "sample string 10",
      "Furniture": [
        {
          "Uri": "sample string 1",
          "FurnitureType": "sample string 2"
        },
        {
          "Uri": "sample string 1",
          "FurnitureType": "sample string 2"
        }
      ],
      "ExternalIdentifiers": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Offers": [
        {
          "Id": 1,
          "StartAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "EndAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "Price": 4.0,
          "Currency": "sample string 5",
          "RentalTime": 1,
          "ViewTime": 1,
          "AssetTypeId": "sample string 6",
          "SupportedDevices": [
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            },
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            }
          ],
          "OfferType": "sample string 7"
        },
        {
          "Id": 1,
          "StartAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "EndAvailability": "2025-09-04T07:14:46.3678649+00:00",
          "Price": 4.0,
          "Currency": "sample string 5",
          "RentalTime": 1,
          "ViewTime": 1,
          "AssetTypeId": "sample string 6",
          "SupportedDevices": [
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            },
            {
              "DeviceType": "sample string 1",
              "Downloadable": true,
              "Streamable": true
            }
          ],
          "OfferType": "sample string 7"
        }
      ],
      "AudioDescriptionAvailable": true
    },
    "MediaAssets": [
      {
        "AssetType": "sample string 1",
        "MaterialTitle": "sample string 2",
        "MediaUri": "http://webapihelppage3.com",
        "KeyId": "sample string 4",
        "AspectRatio": "sample string 5",
        "TranscodeTypeId": 6,
        "TranscodeTypeDescription": "sample string 7"
      },
      {
        "AssetType": "sample string 1",
        "MaterialTitle": "sample string 2",
        "MediaUri": "http://webapihelppage3.com",
        "KeyId": "sample string 4",
        "AspectRatio": "sample string 5",
        "TranscodeTypeId": 6,
        "TranscodeTypeDescription": "sample string 7"
      }
    ],
    "Id": 2,
    "PurchaseOrderId": 3,
    "OfferId": 4,
    "UnitPrice": 5.0,
    "SupplierRef": "sample string 6",
    "TimeOfFirstPlay": "2025-09-04T07:14:46.3678649+00:00",
    "RentalTime": 1,
    "ViewTime": 1,
    "Title": "sample string 7",
    "BbfcRating": "sample string 8",
    "Duration": 9,
    "Deleted": true,
    "RequiresPreRoll": true,
    "PersistentLicenseIssued": true,
    "IsDtr": true,
    "SupportedDevices": "sample string 12",
    "DrmProfile": "sample string 13",
    "LicenseAcknowledged": true,
    "EntitlementTypeId": 15
  }
]