643 matches
100 actions
Rocket Services
100 actions
Other/Rocket Services
Returns the next item to play given a source item id.
For an unwatched show it returns the first episode available to the account.
For a watched show it returns the last incompletely watched episode by the profile, or the episode that immediately follows the last completely watched episode or nothing.
For an episode it always returns the immediately following episode, if available to the account, or nothing.
If the response does not contain a next property then no item was found.
{
"type": "object",
"properties": {
"device": {
"type": "string"
},
"expand": {
"type": "string",
"enum": [
"parent",
"ancestors"
]
},
"ff": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"idp",
"ldp",
"hb",
"rpt",
"cas",
"lrl",
"cd"
]
}
},
"itemId": {
"type": "string"
},
"lang": {
"type": "string"
},
"max_rating": {
"type": "string"
},
"segments": {
"type": "array",
"items": {
"type": "string"
}
},
"sub": {
"type": "string"
}
},
"required": [
"itemId"
],
"additionalProperties": false
}{
"type": "object",
"required": [
"sourceItemId"
],
"properties": {
"firstWatchedDate": {
"type": "string",
"format": "date-time",
"description": "Time when the item corresponding to the itemId passed in by the client was\nfirst watched by the user. Will be `undefined` if the user has never\nwatched the item.\n\nIt can be used to identify the scenario where the user has never watched a\nshow and we are suggesting they watch the first episode (i.e. it is\nmissing in this scenario)\n\n**This will only be populated when a `showId` is passed in**\n"
},
"lastWatchedDate": {
"type": "string",
"format": "date-time",
"description": "Time when the item corresponding to the itemId passed in by the client was\nlast watched by the user. Will be `undefined` if the user has never\nwatched the item.\n\nIt can be used to identify the scenario where the user has never watched a\nshow and we are suggesting they watch the first episode (i.e. it is\nmissing in this scenario)\n\n**This will only be populated when a `showId` is passed in**\n"
},
"next": {
"type": "object"
},
"sourceItemId": {
"type": "string",
"description": "The id of the item used to determine the next item to play."
},
"suggestionType": {
"type": "string",
"description": "Field indicating the type or reason behind the suggestion.\n\nId Type | Show Watched Status| Value | Description\n----------|--------------------|------------------|---------------------------------\nshowId | Unwatched | StartWatching |\nshowId | Completely watched | RestartWatching |\nshowId | Partly watched | ContinueWatching | Suggested episode partly watched\nshowId | Partly watched | Sequential | Suggested episode unwatched\nepisodeId | Any | Sequential | Next episode in show\n",
"enum": [
"StartWatching",
"ContinueWatching",
"RestartWatching",
"Sequential",
"None"
]
}
},
"additionalProperties": false
}