api:iptv:app:watchlist:create
Table of Contents
API : IPTV : App : Watchlist: Create
Introduction
This will put a program on a profile's “watchlist”. These programs can be from the Telecom X archive or from streaming services.
Request
| URL | https://api.telecomx.dk/iptv/app/watchlist/PROFILE_ID/ID | |
|---|---|---|
| Method | POST | |
| Params | PROFILE_ID | ID of DRM profile |
| ID | ID of program | |
| Query | token | Device token |
Query examples
https://api.telecomx.dk/iptv/app/watchlist/1234567890ABCD1234567890/4234567890ABCD1234567890?token=612ysdhsgdHFhasd
Response
| Watchlist object (JSON) | ||
|---|---|---|
| _id | ObjectId | ID |
| programId | String | Unique program ID. |
| profile | ObjectId | Id of DRM profile that has tagged this program. |
| customer | ObjectId | Customer ID |
| duration | Number | Length in minutes. |
| title | String | Title of the program. |
| subTitle | String | Teaser/sub title - short description or episode title for a series episode. |
| description | String | Long description. |
| genres | Array | List of genres, in danish language. |
| series | Object | Episode data - only available for series. |
| series.episode | Number | Episode number in the season, if available. |
| series.episodesInSeason | Number | Number of episodes in the season, if available. |
| series.season | Number | Season number, if available. |
| date | Date | Date program/movie/series was released/first shown, if available. |
| country | string | Country of origin (ISO3166-2 country code). If multiple countries, comma separated string, if available. |
| credits | Array | List of credited persons for this program. |
| credits[].type | String | What the person is credited for: ACTOR, DIRECTOR, PRODUCER, DIRECTOR-PRODUCER e.t.c. |
| credits[].role | String | Name of the role played, if type is ACTOR. |
| credits[].name | String | Name of person. |
| imageIds | Array | List of id's of images for the program. |
| images | Array | List of poster images available for the program. DEPRECATED |
| images[].type | String | Image version data, WIDTHxHEIGHT. |
| images[].url | String | URL to retrieve the image. |
| recording | Boolean | True if program has been recorded or marked for recording by the customer. |
| position | Number | If previously played, then this is the position in seconds where playback stopped. |
| streams | Array | Properties used, if the program is available on streaming services |
| streams[].streamingService | String (enum) | Which streaming service this stream is from. |
| streams[].logo | String | URL to logo of the streaming service |
| streams[].logoId | ObjectId | ID of logo |
| streams[].name | String | Display name of streaming service |
| streams[].url | String | URL/deeplink to content |
Note that properties holding no value may be omitted from the object.
Example - normal
{ _id: '12345678901234567890ABCD', programId: '9934567890ABCD1234567890', profile: '1234567890ABCD1234567890', customer: '4234567890ABCD1234567890', start: '2017-01-14T01:40:00.000Z', end: '2017-01-14T02:30:00.000Z', duration: 50, title: 'Cold Case', subTitle: 'Frank\'s Best', description: 'Krimiserie. Rush og Valens genåbner en sag fra 2001 om en vellidt lokal viktualieforretningsejer, Frank Dicenzio, som tilsyneladende blev banket ihjel af en ansat. Valens kontaktes af broderen til en dømt morder og overbevises om at genåbne sagen. Alle elskede Frank, og ingen kunne forestille sig, at nogen ville slå ham ihjel. Alle beviser peger mod Fransk bedste medarbejder - indtil en person endelig står frem og fortæller sandheden.', genres: [ 'Drama', 'Krimi' ], series: { episode: 10, episodesInSeason: 23, id: '237655889', season: 3 }, credits: [ { type: 'ACTOR', name: 'Kathryn Morris', role: 'Lilly Rush' }, { type: 'ACTOR', name: 'Danny Pino', role: 'Scotty Valens' }, { type: 'ACTOR', name: 'John Finn', role: 'John Stillman' }, { type: 'ACTOR', name: 'Jeremy Ratchford', role: 'Nick Vera' }, { type: 'ACTOR', name: 'Thom Barry', role: 'Will Jeffries' }, { type: 'ACTOR', name: 'Tracie Thoms', role: 'Kat Miller' }, { type: 'ACTOR', name: 'Bahni Turpin', role: 'Lindsey Dunlay' }, { type: 'ACTOR', name: 'Ramon Franco', role: 'Ricardo Munoz' }, { type: 'ACTOR', name: 'James DiStefano', role: 'Frank Dicenzio' }, { type: 'ACTOR', name: 'Sandra Purpuro', role: 'Antonia Difara' }, { type: 'ACTOR', name: 'Eduardo Yanez', role: 'Felix Darosa' }, { type: 'DIRECTOR', name: 'Michael Schultz' } ], imageIds: [ '12345678901234567890BBBB' ], images: [], recording: false, position: 342, streams: [ { streamingService: 'NETFLIX', name: 'Netflix', url: 'https://example.com/video/12937129739/', logo: 'https://image.powernet.tv/1234567890ABCD1234567890.png', logoId: '1234567890ABCD1234567890' } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | drmProfile | Not found |
| 404 | program | Program not found |
| 409 | program | The given program is already on this profile's watchlist |
| 500 | internal_error | <Unspecified> |
api/iptv/app/watchlist/create.txt · Last modified: 2022/10/27 12:15 by Joakim Andersen