GET api/MediaItems/Affiliate/{affiliateId}/Mini?includeParentAndChild={includeParentAndChild}

Returns all the current media items MINI currently available on the platform for a given affiliate

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

The affiliate Id

integer

Required

includeParentAndChild

Include Parent and Child Mini. Default = false

boolean

Default value is False

v

The requested API version

string

Default value is 2.0

Body Parameters

None.

Response Information

Resource Description

Returns all the current media items MINI currently available on the platform for a given affiliate

Collection of FilmFlex.Platform.Common.API.Contracts.V2.MediaItemMiniDTO
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.

ShortSynopsis

Short Synopsis (Max 60 chars)

string

Max length: 60

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.

Classification

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

string

None.

Furniture

A list of Media Item furniture (usually images)

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

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.V2.OfferDTO

None.

NumberInSequence

Episode or Series Number

integer

None.

TotalNumberOfParts

Total number of Episodes or Series

integer

None.

Id

Media Item Id

integer

None.

ParentId

Media Item parent id

integer

None.

ReleaseYear

The year the film was released

integer

None.

Duration

Movie duration in MINUTES

string

None.

Cast

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

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

None.

NewsletterSynopsis

Newsletter Synopsis (Max 500 chars)

string

Max length: 500

Certificate

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

string

None.

AffiliateContentAdvice

string

None.

BoxSets

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

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SupplierReference": "sample string 1",
    "Title": "sample string 2",
    "SortTitle": "sample string 3",
    "ShortSynopsis": "sample string 4",
    "FurnitureBaseUrl": "sample string 5",
    "Classification": "sample string 6",
    "Furniture": [
      {
        "Uri": "sample string 1",
        "FurnitureType": "sample string 2"
      },
      {
        "Uri": "sample string 1",
        "FurnitureType": "sample string 2"
      }
    ],
    "Offers": [
      {
        "Id": 1,
        "StartAvailability": "2025-09-02T13:35:45.8008813+00:00",
        "EndAvailability": "2025-09-02T13:35:45.8008813+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:45.8008813+00:00",
        "EndAvailability": "2025-09-02T13:35:45.8008813+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"
      }
    ],
    "NumberInSequence": 1,
    "TotalNumberOfParts": 1,
    "Id": 7,
    "ParentId": 1,
    "ReleaseYear": 8,
    "Duration": "sample string 9",
    "Cast": [
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      },
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      }
    ],
    "NewsletterSynopsis": "sample string 10",
    "Certificate": "sample string 11",
    "AffiliateContentAdvice": "sample string 12",
    "BoxSets": [
      {
        "Id": 1,
        "SupplierReference": "sample string 2",
        "Title": "sample string 3",
        "Price": 4.0,
        "Currency": "sample string 5"
      },
      {
        "Id": 1,
        "SupplierReference": "sample string 2",
        "Title": "sample string 3",
        "Price": 4.0,
        "Currency": "sample string 5"
      }
    ]
  },
  {
    "SupplierReference": "sample string 1",
    "Title": "sample string 2",
    "SortTitle": "sample string 3",
    "ShortSynopsis": "sample string 4",
    "FurnitureBaseUrl": "sample string 5",
    "Classification": "sample string 6",
    "Furniture": [
      {
        "Uri": "sample string 1",
        "FurnitureType": "sample string 2"
      },
      {
        "Uri": "sample string 1",
        "FurnitureType": "sample string 2"
      }
    ],
    "Offers": [
      {
        "Id": 1,
        "StartAvailability": "2025-09-02T13:35:45.8008813+00:00",
        "EndAvailability": "2025-09-02T13:35:45.8008813+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:45.8008813+00:00",
        "EndAvailability": "2025-09-02T13:35:45.8008813+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"
      }
    ],
    "NumberInSequence": 1,
    "TotalNumberOfParts": 1,
    "Id": 7,
    "ParentId": 1,
    "ReleaseYear": 8,
    "Duration": "sample string 9",
    "Cast": [
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      },
      {
        "Type": "sample string 1",
        "FullName": "sample string 2"
      }
    ],
    "NewsletterSynopsis": "sample string 10",
    "Certificate": "sample string 11",
    "AffiliateContentAdvice": "sample string 12",
    "BoxSets": [
      {
        "Id": 1,
        "SupplierReference": "sample string 2",
        "Title": "sample string 3",
        "Price": 4.0,
        "Currency": "sample string 5"
      },
      {
        "Id": 1,
        "SupplierReference": "sample string 2",
        "Title": "sample string 3",
        "Price": 4.0,
        "Currency": "sample string 5"
      }
    ]
  }
]