GET api/Collections/{affiliateId}?collectionName={collectionName}
Returns the list of valid Collections for a particular affiliate, including a count of movies in the list.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
affiliateId |
The affiliate Id |
integer |
Required |
collectionName |
For comparasion with Collection.Title field for filter |
string |
Default value is |
v |
The requested API version |
string |
Default value is 2.0 |
Body Parameters
None.
Response Information
Resource Description
Returns the list of valid Collections for a particular affiliate, including a count of movies in the list.
Collection of FilmFlex.Platform.Common.API.Contracts.V2.CollectionCountDTOName | Description | Type | Additional information |
---|---|---|---|
TotalMediaItemsCount |
The count of active available movies in this Genre |
integer |
None. |
BrandsCount |
Gets or sets the brands count. |
integer |
None. |
SeasonsCount |
Gets or sets the seasons count. |
integer |
None. |
EpisodesCount |
Gets or sets the episodes count. |
integer |
None. |
MoviesCount |
Gets or sets the movies count. |
integer |
None. |
TVBoxSetsCount | integer |
None. |
|
MovieBoxSetsCount | integer |
None. |
|
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. |
IsBundle | 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. |
ImageUrl |
Gets or sets the image URL. |
string |
None. |
DataFile |
Gets or sets the data file. |
Collection of byte |
None. |
BundleOffer | FilmFlex.Platform.Common.API.Contracts.V2.BundleOfferDTO |
None. |
Response Formats
application/json, text/json
[ { "TotalMediaItemsCount": 1, "BrandsCount": 2, "SeasonsCount": 3, "EpisodesCount": 4, "MoviesCount": 5, "TVBoxSetsCount": 6, "MovieBoxSetsCount": 7, "Id": 8, "Title": "sample string 9", "Description": "sample string 10", "CollectionType": "sample string 11", "IsSpecial": true, "IsMobileOnly": true, "IsBundle": true, "AffiliateId": 15, "StartDate": "2025-09-04T07:12:38.2543907+00:00", "EndDate": "2025-09-04T07:12:38.2543907+00:00", "ImageUrl": "sample string 16", "DataFile": "QEA=", "BundleOffer": { "Id": 1, "Title": "sample string 2", "Description": "sample string 3", "MinSelectQuantity": 4, "OfferQuantity": 5, "OfferPrice": 1.0, "OfferPriceReductionPercentage": 1, "HighOrLowPricedTitlesOffered": "sample string 6", "LinkedCollectionsCount": 7 } }, { "TotalMediaItemsCount": 1, "BrandsCount": 2, "SeasonsCount": 3, "EpisodesCount": 4, "MoviesCount": 5, "TVBoxSetsCount": 6, "MovieBoxSetsCount": 7, "Id": 8, "Title": "sample string 9", "Description": "sample string 10", "CollectionType": "sample string 11", "IsSpecial": true, "IsMobileOnly": true, "IsBundle": true, "AffiliateId": 15, "StartDate": "2025-09-04T07:12:38.2543907+00:00", "EndDate": "2025-09-04T07:12:38.2543907+00:00", "ImageUrl": "sample string 16", "DataFile": "QEA=", "BundleOffer": { "Id": 1, "Title": "sample string 2", "Description": "sample string 3", "MinSelectQuantity": 4, "OfferQuantity": 5, "OfferPrice": 1.0, "OfferPriceReductionPercentage": 1, "HighOrLowPricedTitlesOffered": "sample string 6", "LinkedCollectionsCount": 7 } } ]