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

Returns all the curated collections that the selected Media Item is in.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
affiliateId

The Affiliate Id

integer

Required

supplierRef

The Media Items supplierRef

string

Required

v

The requested API version

string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Returns all the curated collections that the selected Media Item is in.

Collection of FilmFlex.Platform.Common.API.Contracts.V1.CollectionDTO
NameDescriptionTypeAdditional information
Id

The unique Id of the collection

integer

None.

Title

The name of the Collection

string

None.

Description

The collections description

string

None.

CollectionType

The type of collection. General, BestSellers,NewReleases,SpecialOffers,RecommendedForDevice

string

None.

IsSpecial

Is this collection 'special'? If so then this may need to appear as fixed headings in a UI

boolean

None.

IsMobileOnly

Is this collection for rendering on mobile clients only?

boolean

None.

AffiliateId

The Affiliate Id to which this collection applies

integer

None.

StartDate

If a special collection this is the time it is published from

date

None.

EndDate

If a special collection this is the time it is published to

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "CollectionType": "sample string 4",
    "IsSpecial": true,
    "IsMobileOnly": true,
    "AffiliateId": 7,
    "StartDate": "2025-09-04T07:14:46.7272204+00:00",
    "EndDate": "2025-09-04T07:14:46.7272204+00:00"
  },
  {
    "Id": 1,
    "Title": "sample string 2",
    "Description": "sample string 3",
    "CollectionType": "sample string 4",
    "IsSpecial": true,
    "IsMobileOnly": true,
    "AffiliateId": 7,
    "StartDate": "2025-09-04T07:14:46.7272204+00:00",
    "EndDate": "2025-09-04T07:14:46.7272204+00:00"
  }
]