GET api/Collections/MediaItems/{affiliateId}?collectionName={collectionName}

Returns all the media items in a given collection

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

The affiliate Id

integer

Required

collectionName

The name of the collection

string

Required

v

The requested API version

string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Returns all the media items in a given collection

Collection of FilmFlex.Platform.Common.API.Contracts.V1.MediaItemMaxDTO
NameDescriptionTypeAdditional information
SupplierReference

The unique reference to this movie asset

string

None.

Title

The full Film or Episode Title

string

None.

SortTitle

Title to be used for sorting only

string

None.

TitleKeywords

Title keywords where special charcters have been substituted. To be used for internal english based searches.

string

None.

ReleaseYear

The year the film was released

integer

None.

Certificate

This is the Media Items Certificate rating. e.g. '15', 'PG', 'U' etc..

string

None.

Duration

Movie duration in MINUTES

string

None.

Classification

This is the Media Item type classification. e.g. 'Movie', 'Series', 'Season' or 'Episode'

string

None.

Cast

A collection of cast and production members names and their role. Including Directors.

Collection of FilmFlex.Platform.Common.API.Contracts.V1.CastDTO

None.

NewsletterSynopsis

Newsletter Synopsis (Max 500 chars)

string

Max length: 500

LongSynopsis

Long Synopsis (Max 255 chars)

string

Max length: 255

MediumSynopsis

Medium Synopsis (Max 180 chars)

string

Max length: 180

ShortSynopsis

Short Synopsis (Max 60 chars)

string

Max length: 60

TrailerUri

Url to the trailer video asset

string

None.

FurnitureBaseUrl

The base Url to prefix all furniture image url properties with to resolve the full location. This is the largest common component found and is to help reduce the size of the return payload. Prefix all Furniture Uris with this to get the full asset Uri

string

None.

Furniture

A list of Media Item furniture (usually images)

Collection of FilmFlex.Platform.Common.API.Contracts.V1.FurnitureDTO

None.

ExternalIdentifiers

A list of key - values that hold indentifiers used by external parties that relate to a Media Item.

Collection of FilmFlex.Platform.Common.API.Contracts.V1.ExternalIdentifierDTO

None.

Offers

Collection of Offers available for this Media Item and Affiliate. This includes the type of media items (HD, SD), price, currency and dates.

Collection of FilmFlex.Platform.Common.API.Contracts.V1.OfferDTO

None.

AudioDescriptionAvailable

Gets or sets the audio description available.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "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",
    "Classification": "sample string 8",
    "Cast": [
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      },
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      }
    ],
    "NewsletterSynopsis": "sample string 9",
    "LongSynopsis": "sample string 10",
    "MediumSynopsis": "sample string 11",
    "ShortSynopsis": "sample string 12",
    "TrailerUri": "sample string 13",
    "FurnitureBaseUrl": "sample string 14",
    "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:10:16.845082+00:00",
        "EndAvailability": "2025-09-04T07:10:16.845082+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:10:16.845082+00:00",
        "EndAvailability": "2025-09-04T07:10:16.845082+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
  },
  {
    "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",
    "Classification": "sample string 8",
    "Cast": [
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      },
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      }
    ],
    "NewsletterSynopsis": "sample string 9",
    "LongSynopsis": "sample string 10",
    "MediumSynopsis": "sample string 11",
    "ShortSynopsis": "sample string 12",
    "TrailerUri": "sample string 13",
    "FurnitureBaseUrl": "sample string 14",
    "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:10:16.845082+00:00",
        "EndAvailability": "2025-09-04T07:10:16.845082+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:10:16.845082+00:00",
        "EndAvailability": "2025-09-04T07:10:16.845082+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
  }
]