GET api/MediaItems/Offer/{affiliateId}/{tmsId}

Gets the media asset by grace note identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

The affiliate identifier.

integer

Required

tmsId

The grace note identifier.

string

Required

v

The requested API version

string

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Gets the media asset by grace note identifier.

Collection of FilmFlex.Platform.Common.API.Contracts.V2.OfferDTO
NameDescriptionTypeAdditional information
Id

The unique Offer identifier

integer

None.

StartAvailability

Start availability of the offer

date

None.

EndAvailability

End availability of the offer

date

None.

Price

The price in the currency indicated

decimal number

None.

Currency

The currency code that the price is given in

string

None.

RentalTime

If rented this is the time in DAYS allowed till first play

integer

None.

ViewTime

Once started this is the legth of time in HOURS the user has to finish viewing the movie

integer

None.

AssetTypeId

The type of asset this offer applies to (usually HD or SD)

string

None.

SupportedDevices

The list of supported capabilities for each device category

Collection of FilmFlex.Platform.Common.API.Contracts.V2.SupportedDeviceDTO

None.

WholeSalePrice

decimal number

None.

RetailPrice

decimal number

None.

OfferType

Gets or sets the type of the offer.

string

None.

SubscriptionTiers

Gets or sets the subscription tiers.

Collection of FilmFlex.Platform.Common.API.Contracts.V2.SubscriptionTierDTO

None.

LowSupplierReference

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "StartAvailability": "2025-09-02T13:35:50.4884578+00:00",
    "EndAvailability": "2025-09-02T13:35:50.4884578+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
      }
    ],
    "WholeSalePrice": 1.0,
    "RetailPrice": 1.0,
    "OfferType": "sample string 7",
    "SubscriptionTiers": [
      {
        "Name": "sample string 1"
      },
      {
        "Name": "sample string 1"
      }
    ],
    "LowSupplierReference": "sample string 8"
  },
  {
    "Id": 1,
    "StartAvailability": "2025-09-02T13:35:50.4884578+00:00",
    "EndAvailability": "2025-09-02T13:35:50.4884578+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
      }
    ],
    "WholeSalePrice": 1.0,
    "RetailPrice": 1.0,
    "OfferType": "sample string 7",
    "SubscriptionTiers": [
      {
        "Name": "sample string 1"
      },
      {
        "Name": "sample string 1"
      }
    ],
    "LowSupplierReference": "sample string 8"
  }
]