Last active
October 26, 2019 17:20
-
-
Save nvllsvm/734095328e62f3f4639515daf8e61174 to your computer and use it in GitHub Desktop.
Rough description of the Jellyfin HTTP API. Some parts are probably inaccurate.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "/Albums/{Id}/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates an instant playlist based on a given album" | |
| } | |
| }, | |
| "/Artists": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all artists from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Artists/AlbumArtists": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all album artists from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Artists/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The artist Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Creates an instant playlist based on a given artist" | |
| } | |
| }, | |
| "/Artists/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The artist name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets an artist, by name" | |
| } | |
| }, | |
| "/Artists/{Name}/Images/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Artists/{Name}/Images/{Type}/{Index}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Audio/{Id}/hls/{SegmentId}/stream.aac": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Audio/{Id}/hls/{SegmentId}/stream.mp3": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Audio/{Id}/hls1/{PlaylistId}/{SegmentId}.{SegmentContainer}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Audio/{Id}/main.m3u8": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream using HTTP live streaming." | |
| } | |
| }, | |
| "/Audio/{Id}/master.m3u8": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream using HTTP live streaming." | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream using HTTP live streaming." | |
| } | |
| }, | |
| "/Audio/{Id}/stream": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| } | |
| }, | |
| "/Audio/{Id}/stream.{Container}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| } | |
| }, | |
| "/Audio/{Id}/universal": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| }, | |
| "HEAD": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| } | |
| }, | |
| "/Audio/{Id}/universal.{Container}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets an audio stream" | |
| } | |
| }, | |
| "/Auth/Keys": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "App", | |
| "IsRequired": true, | |
| "Name": "App", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Auth/Keys/{Key}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Auth Key", | |
| "IsRequired": true, | |
| "Name": "Key", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Auth/PasswordResetProviders": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Auth/Providers": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Branding/Configuration": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets branding configuration" | |
| } | |
| }, | |
| "/Branding/Css": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets custom css" | |
| } | |
| }, | |
| "/Branding/Css.css": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets custom css" | |
| } | |
| }, | |
| "/Channels": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional. Filter by channels that support getting latest items.", | |
| "IsRequired": false, | |
| "Name": "SupportsLatestItems", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available channels" | |
| } | |
| }, | |
| "/Channels/Features": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets features for a channel" | |
| } | |
| }, | |
| "/Channels/Items/Latest": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", | |
| "IsRequired": false, | |
| "Name": "Filters", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify one or more channel id's, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "ChannelIds", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets channel items" | |
| } | |
| }, | |
| "/Channels/{Id}/Features": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Channel Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets features for a channel" | |
| } | |
| }, | |
| "/Channels/{Id}/Items": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Channel Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Folder Id", | |
| "IsRequired": false, | |
| "Name": "FolderId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Sort Order - Ascending,Descending", | |
| "IsRequired": false, | |
| "Name": "SortOrder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", | |
| "IsRequired": false, | |
| "Name": "Filters", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", | |
| "IsRequired": false, | |
| "Name": "SortBy", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets channel items" | |
| } | |
| }, | |
| "/Collections": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "bool", | |
| "Description": "Whether or not to lock the new collection.", | |
| "IsRequired": false, | |
| "Name": "IsLocked", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the new collection.", | |
| "IsRequired": false, | |
| "Name": "Name", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional - create the collection within a specific folder", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Item Ids to add to the collection", | |
| "IsRequired": false, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Creates a new collection" | |
| } | |
| }, | |
| "/Collections/{Id}/Items": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item id, comma delimited", | |
| "IsRequired": true, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The media version id, if playing an alternate version", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The device id of the client requesting. Used to stop encoding processes when needed.", | |
| "IsRequired": false, | |
| "Name": "DeviceId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. Specify a starting offset, in ticks. 1 tick = 10000 ms", | |
| "IsRequired": false, | |
| "Name": "StartTimeTicks", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Removes items from a collection" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item id, comma delimited", | |
| "IsRequired": true, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Adds items to a collection" | |
| } | |
| }, | |
| "/Devices": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a device" | |
| }, | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all devices" | |
| } | |
| }, | |
| "/Devices/CameraUploads": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets camera upload history for a device" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "DeviceId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Album", | |
| "IsRequired": true, | |
| "Name": "Album", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Uploads content" | |
| } | |
| }, | |
| "/Devices/Info": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets info for a device" | |
| } | |
| }, | |
| "/Devices/Options": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets options for a device" | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Device Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The image type", | |
| "IsRequired": false, | |
| "Name": "Type", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image provider to use", | |
| "IsRequired": false, | |
| "Name": "ProviderName", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional.", | |
| "IsRequired": false, | |
| "Name": "IncludeAllLanguages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Updates device options" | |
| } | |
| }, | |
| "/DisplayPreferences/{DisplayPreferencesId}": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "DisplayPreferences Id", | |
| "IsRequired": true, | |
| "Name": "DisplayPreferencesId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates a user's display preferences for an item" | |
| } | |
| }, | |
| "/DisplayPreferences/{Id}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Client", | |
| "IsRequired": true, | |
| "Name": "Client", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a user's display preferences for an item" | |
| } | |
| }, | |
| "/Environment/DefaultDirectoryBrowser": { | |
| "GET": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets the parent path of a given path" | |
| } | |
| }, | |
| "/Environment/DirectoryContents": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Path", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "An optional filter to include or exclude files from the results. true/false", | |
| "IsRequired": false, | |
| "Name": "IncludeFiles", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "An optional filter to include or exclude folders from the results. true/false", | |
| "IsRequired": false, | |
| "Name": "IncludeDirectories", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets the contents of a given directory in the file system" | |
| } | |
| }, | |
| "/Environment/Drives": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets available drives from the server's file system" | |
| } | |
| }, | |
| "/Environment/NetworkDevices": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a list of devices on the network" | |
| } | |
| }, | |
| "/Environment/NetworkShares": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Path", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets shares from a network device" | |
| } | |
| }, | |
| "/Environment/ParentPath": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Path", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets the parent path of a given path" | |
| } | |
| }, | |
| "/Environment/ValidatePath": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Path", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Gets the contents of a given directory in the file system" | |
| } | |
| }, | |
| "/Genres": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all genres from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Genres/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The genre name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by maximum official rating (PG, PG-13, TV-MA, etc).", | |
| "IsRequired": false, | |
| "Name": "MaxOfficialRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items with theme songs.", | |
| "IsRequired": false, | |
| "Name": "HasThemeSong", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items with theme videos.", | |
| "IsRequired": false, | |
| "Name": "HasThemeVideo", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items with subtitles.", | |
| "IsRequired": false, | |
| "Name": "HasSubtitles", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items with special features.", | |
| "IsRequired": false, | |
| "Name": "HasSpecialFeature", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items with trailers.", | |
| "IsRequired": false, | |
| "Name": "HasTrailer", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Return items that are siblings of a supplied item.", | |
| "IsRequired": false, | |
| "Name": "AdjacentTo", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional filter by minimum index number.", | |
| "IsRequired": false, | |
| "Name": "MinIndexNumber", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional filter by parent index number.", | |
| "IsRequired": false, | |
| "Name": "ParentIndexNumber", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that have or do not have a parental rating", | |
| "IsRequired": false, | |
| "Name": "HasParentalRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are HD or not.", | |
| "IsRequired": false, | |
| "Name": "IsHD", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "LocationTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on LocationType. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "ExcludeLocationTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are missing episodes or not.", | |
| "IsRequired": false, | |
| "Name": "IsMissing", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are unaired episodes or not.", | |
| "IsRequired": false, | |
| "Name": "IsUnaired", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional filter by minimum community rating.", | |
| "IsRequired": false, | |
| "Name": "MinCommunityRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional filter by minimum critic rating.", | |
| "IsRequired": false, | |
| "Name": "MinCriticRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Gets all episodes that aired during a season, including specials.", | |
| "IsRequired": false, | |
| "Name": "AiredDuringSeason", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinPremiereDate", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinDateLastSaved", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinDateLastSavedForUser", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The maximum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MaxPremiereDate", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that have an overview or not.", | |
| "IsRequired": false, | |
| "Name": "HasOverview", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that have an imdb id or not.", | |
| "IsRequired": false, | |
| "Name": "HasImdbId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that have a tmdb id or not.", | |
| "IsRequired": false, | |
| "Name": "HasTmdbId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that have a tvdb id or not.", | |
| "IsRequired": false, | |
| "Name": "HasTvdbId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered by exxcluding item ids. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "ExcludeItemIds", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "When searching within folders, this determines whether or not the search will be recursive. true/false", | |
| "IsRequired": false, | |
| "Name": "Recursive", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Sort Order - Ascending,Descending", | |
| "IsRequired": false, | |
| "Name": "SortOrder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "ExcludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "IncludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional filters to apply. This allows multiple, comma delimeted. Options: IsFolder, IsNotFolder, IsUnplayed, IsPlayed, IsFavorite, IsResumable, Likes, Dislikes", | |
| "IsRequired": false, | |
| "Name": "Filters", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are marked as favorite, or not.", | |
| "IsRequired": false, | |
| "Name": "IsFavorite", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional filter by MediaType. Allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "MediaTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on those containing image types. This allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "ImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", | |
| "IsRequired": false, | |
| "Name": "SortBy", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are played, or not.", | |
| "IsRequired": false, | |
| "Name": "IsPlayed", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on genre. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "Genres", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on OfficialRating. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "OfficialRatings", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on tag. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "Tags", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on production year. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "Years", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered to include only those containing the specified person.", | |
| "IsRequired": false, | |
| "Name": "Person", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered to include only those containing the specified person.", | |
| "IsRequired": false, | |
| "Name": "PersonIds", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. If specified, along with Person, results will be filtered to include only those containing the specified person and PersonType. Allows multiple, comma-delimited", | |
| "IsRequired": false, | |
| "Name": "PersonTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "Studios", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on studio. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "StudioIds", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "Artists", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on artist. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "ArtistIds", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on album. This allows multiple, pipe delimeted.", | |
| "IsRequired": false, | |
| "Name": "Albums", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specific items are needed, specify a list of item id's to retrieve. This allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional filter by VideoType (videofile, dvd, bluray, iso). Allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "VideoTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by minimum official rating (PG, PG-13, TV-MA, etc).", | |
| "IsRequired": false, | |
| "Name": "MinOfficialRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items that are locked.", | |
| "IsRequired": false, | |
| "Name": "IsLocked", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items that are placeholders", | |
| "IsRequired": false, | |
| "Name": "IsPlaceHolder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items that have official ratings", | |
| "IsRequired": false, | |
| "Name": "HasOfficialRating", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Whether or not to hide items behind their boxsets.", | |
| "IsRequired": false, | |
| "Name": "CollapseBoxSetItems", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are 3D, or not.", | |
| "IsRequired": false, | |
| "Name": "Is3D", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional filter by Series Status. Allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "SeriesStatus", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items whose name is sorted equally or greater than a given input string.", | |
| "IsRequired": false, | |
| "Name": "NameStartsWithOrGreater", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items whose name is sorted equally than a given input string.", | |
| "IsRequired": false, | |
| "Name": "NameStartsWith", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by items whose name is equally or lesser than a given input string.", | |
| "IsRequired": false, | |
| "Name": "NameLessThan", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a genre, by name" | |
| } | |
| }, | |
| "/Genres/{Name}/Images/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Genres/{Name}/Images/{Type}/{Index}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Images/General": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all general images by name" | |
| } | |
| }, | |
| "/Images/General/{Name}/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the image", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Image Type (primary, backdrop, logo, etc).", | |
| "IsRequired": true, | |
| "Name": "Type", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a general image by name" | |
| } | |
| }, | |
| "/Images/MediaInfo": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all media info image by name" | |
| } | |
| }, | |
| "/Images/MediaInfo/{Theme}/{Name}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the image", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The theme to get the image from", | |
| "IsRequired": true, | |
| "Name": "Theme", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a media info image by name" | |
| } | |
| }, | |
| "/Images/Ratings": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all rating images by name" | |
| } | |
| }, | |
| "/Images/Ratings/{Theme}/{Name}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the image", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The theme to get the image from", | |
| "IsRequired": true, | |
| "Name": "Theme", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a rating image by name" | |
| } | |
| }, | |
| "/Images/Remote": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The image url", | |
| "IsRequired": true, | |
| "Name": "ImageUrl", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a remote image" | |
| } | |
| }, | |
| "/Items": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Ids", | |
| "IsRequired": true, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes an item from the library and file system" | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets items based on a query." | |
| } | |
| }, | |
| "/Items/Counts": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Get counts from a specific user's library.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Get counts of favorite items", | |
| "IsRequired": false, | |
| "Name": "IsFavorite", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/Filters": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "IncludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional filter by MediaType. Allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "MediaTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets branding configuration" | |
| } | |
| }, | |
| "/Items/Filters2": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "IncludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional filter by MediaType. Allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "MediaTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Specifies the metadata refresh mode", | |
| "IsRequired": false, | |
| "Name": "MetadataRefreshMode", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Specifies the image refresh mode", | |
| "IsRequired": false, | |
| "Name": "ImageRefreshMode", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Determines if metadata should be replaced. Only applicable if mode is FullRefresh", | |
| "IsRequired": false, | |
| "Name": "ReplaceAllMetadata", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Determines if images should be replaced. Only applicable if mode is FullRefresh", | |
| "IsRequired": false, | |
| "Name": "ReplaceAllImages", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Gets branding configuration" | |
| } | |
| }, | |
| "/Items/RemoteSearch/Apply/{Id}": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The item id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Whether or not to replace all images", | |
| "IsRequired": false, | |
| "Name": "ReplaceAllImages", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Applies search criteria to an item and refreshes metadata" | |
| } | |
| }, | |
| "/Items/RemoteSearch/Book": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/BoxSet": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/Image": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The image url", | |
| "IsRequired": true, | |
| "Name": "ImageUrl", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "ProviderName", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a remote image" | |
| } | |
| }, | |
| "/Items/RemoteSearch/Movie": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/MusicAlbum": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/MusicArtist": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/MusicVideo": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/Person": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/Series": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/RemoteSearch/Trailer": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes an item from the library and file system" | |
| } | |
| }, | |
| "/Items/{Id}/Ancestors": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets all parents of an item" | |
| } | |
| }, | |
| "/Items/{Id}/CriticReviews": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets critic reviews for an item" | |
| } | |
| }, | |
| "/Items/{Id}/Download": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "download" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Downloads item media" | |
| } | |
| }, | |
| "/Items/{Id}/ExternalIdInfos": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets external id infos for an item" | |
| } | |
| }, | |
| "/Items/{Id}/File": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets the original file of an item" | |
| } | |
| }, | |
| "/Items/{Id}/Images": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets information about an item's images" | |
| } | |
| }, | |
| "/Items/{Id}/Images/{Type}": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}/Images/{Type}/{Index}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": null | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}/Images/{Type}/{Index}/Index": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Image Type", | |
| "IsRequired": true, | |
| "Name": "Type", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Image Index", | |
| "IsRequired": false, | |
| "Name": "Index", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The new image index", | |
| "IsRequired": true, | |
| "Name": "NewIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates the index for an item image" | |
| } | |
| }, | |
| "/Items/{Id}/Images/{Type}/{Index}/{Tag}/{Format}/{MaxWidth}/{MaxHeight}/{PercentPlayed}/{UnplayedCount}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}/InstantMix": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates an instant playlist based on a given item" | |
| } | |
| }, | |
| "/Items/{Id}/PlaybackInfo": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets live playback media info for an item" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets live playback media info for an item" | |
| } | |
| }, | |
| "/Items/{Id}/Refresh": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "bool", | |
| "Description": "Indicates if the refresh should occur recursively.", | |
| "IsRequired": false, | |
| "Name": "Recursive", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Refreshes metadata for an item" | |
| } | |
| }, | |
| "/Items/{Id}/RemoteImages": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available remote images for an item" | |
| } | |
| }, | |
| "/Items/{Id}/RemoteImages/Download": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Downloads a remote image for an item" | |
| } | |
| }, | |
| "/Items/{Id}/RemoteImages/Providers": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The image type", | |
| "IsRequired": true, | |
| "Name": "Type", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The image provider", | |
| "IsRequired": false, | |
| "Name": "ProviderName", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The image url", | |
| "IsRequired": false, | |
| "Name": "ImageUrl", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| } | |
| ], | |
| "summary": "Gets available remote image providers for an item" | |
| } | |
| }, | |
| "/Items/{Id}/RemoteSearch/Subtitles/{Language}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Language", | |
| "IsRequired": true, | |
| "Name": "Language", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}/RemoteSearch/Subtitles/{SubtitleId}": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "SubtitleId", | |
| "IsRequired": true, | |
| "Name": "SubtitleId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Items/{Id}/Similar": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets similar items" | |
| } | |
| }, | |
| "/Items/{Id}/ThemeMedia": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Determines whether or not parent items should be searched for theme media.", | |
| "IsRequired": false, | |
| "Name": "InheritFromParent", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets theme videos and songs for an item" | |
| } | |
| }, | |
| "/Items/{Id}/ThemeSongs": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Determines whether or not parent items should be searched for theme media.", | |
| "IsRequired": false, | |
| "Name": "InheritFromParent", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets theme songs for an item" | |
| } | |
| }, | |
| "/Items/{Id}/ThemeVideos": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Determines whether or not parent items should be searched for theme media.", | |
| "IsRequired": false, | |
| "Name": "InheritFromParent", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets theme videos for an item" | |
| } | |
| }, | |
| "/Items/{ItemId}": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the item", | |
| "IsRequired": true, | |
| "Name": "ItemId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates an item" | |
| } | |
| }, | |
| "/Items/{ItemId}/ContentType": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the item", | |
| "IsRequired": true, | |
| "Name": "ItemId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The content type of the item", | |
| "IsRequired": true, | |
| "Name": "ContentType", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates an item's content type" | |
| } | |
| }, | |
| "/Items/{ItemId}/MetadataEditor": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the item", | |
| "IsRequired": true, | |
| "Name": "ItemId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets metadata editor info for an item" | |
| } | |
| }, | |
| "/Libraries/AvailableOptions": { | |
| "GET": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Library/Media/Updated": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "A list of updated media paths", | |
| "IsRequired": false, | |
| "Name": "Updates", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports that new movies have been added by an external source" | |
| } | |
| }, | |
| "/Library/MediaFolders": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional. Filter by folders that are marked hidden, or not.", | |
| "IsRequired": false, | |
| "Name": "IsHidden", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets all user media folders." | |
| } | |
| }, | |
| "/Library/Movies/Added": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports that new movies have been added by an external source" | |
| } | |
| }, | |
| "/Library/Movies/Updated": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Tmdb Id", | |
| "IsRequired": false, | |
| "Name": "TmdbId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Imdb Id", | |
| "IsRequired": false, | |
| "Name": "ImdbId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports that new movies have been added by an external source" | |
| } | |
| }, | |
| "/Library/PhysicalPaths": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a list of physical paths from virtual folders" | |
| } | |
| }, | |
| "/Library/Refresh": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Starts a library scan" | |
| } | |
| }, | |
| "/Library/Series/Added": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports that new episodes of a series have been added by an external source" | |
| } | |
| }, | |
| "/Library/Series/Updated": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Tvdb Id", | |
| "IsRequired": false, | |
| "Name": "TvdbId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports that new episodes of a series have been added by an external source" | |
| } | |
| }, | |
| "/Library/VirtualFolders": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Library/VirtualFolders/LibraryOptions": { | |
| "POST": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Library/VirtualFolders/Name": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Library/VirtualFolders/Paths": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Library/VirtualFolders/Paths/Update": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/LiveStreams/Close": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "LiveStreamId", | |
| "IsRequired": true, | |
| "Name": "LiveStreamId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Closes a media source" | |
| } | |
| }, | |
| "/LiveStreams/Open": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Opens a media source" | |
| } | |
| }, | |
| "/LiveTv/Channels": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by channel type.", | |
| "IsRequired": false, | |
| "Name": "Type", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user and attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsMovie", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsSeries", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for news.", | |
| "IsRequired": false, | |
| "Name": "IsNews", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for kids.", | |
| "IsRequired": false, | |
| "Name": "IsKids", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for sports.", | |
| "IsRequired": false, | |
| "Name": "IsSports", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Filter by channels that are favorites, or not.", | |
| "IsRequired": false, | |
| "Name": "IsFavorite", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Filter by channels that are liked, or not.", | |
| "IsRequired": false, | |
| "Name": "IsLiked", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Filter by channels that are disliked, or not.", | |
| "IsRequired": false, | |
| "Name": "IsDisliked", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Incorporate favorite and like status into channel sorting.", | |
| "IsRequired": false, | |
| "Name": "EnableFavoriteSorting", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Adds current program info to each channel", | |
| "IsRequired": false, | |
| "Name": "AddCurrentProgram", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available live tv channels." | |
| } | |
| }, | |
| "/LiveTv/Channels/{Id}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Channel Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a live tv channel" | |
| } | |
| }, | |
| "/LiveTv/GuideInfo": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets guide info" | |
| } | |
| }, | |
| "/LiveTv/Info": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets available live tv services." | |
| } | |
| }, | |
| "/LiveTv/ListingProviders": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Provider id", | |
| "IsRequired": false, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a listing provider" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Adds a listing provider" | |
| } | |
| }, | |
| "/LiveTv/ListingProviders/Default": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/LiveTv/ListingProviders/Lineups": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Provider id", | |
| "IsRequired": false, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Provider Type", | |
| "IsRequired": false, | |
| "Name": "Type", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Location", | |
| "IsRequired": false, | |
| "Name": "Location", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Country", | |
| "IsRequired": false, | |
| "Name": "Country", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available lineups" | |
| } | |
| }, | |
| "/LiveTv/ListingProviders/SchedulesDirect/Countries": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets available lineups" | |
| } | |
| }, | |
| "/LiveTv/LiveRecordings/{Id}/stream": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a live tv channel" | |
| } | |
| }, | |
| "/LiveTv/LiveStreamFiles/{Id}/stream.{Container}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a live tv channel" | |
| } | |
| }, | |
| "/LiveTv/Programs": { | |
| "GET,POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The channels to return guide information for.", | |
| "IsRequired": false, | |
| "Name": "ChannelIds", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user id.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinStartDate", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Filter by programs that have completed airing, or not.", | |
| "IsRequired": false, | |
| "Name": "HasAired", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The maximum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MaxStartDate", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinEndDate", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The maximum premiere date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MaxEndDate", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsMovie", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsSeries", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for news.", | |
| "IsRequired": false, | |
| "Name": "IsNews", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for kids.", | |
| "IsRequired": false, | |
| "Name": "IsKids", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for sports.", | |
| "IsRequired": false, | |
| "Name": "IsSports", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify one or more sort orders, comma delimeted. Options: Name, StartDate", | |
| "IsRequired": false, | |
| "Name": "SortBy", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Sort Order - Ascending,Descending", | |
| "IsRequired": false, | |
| "Name": "SortOrder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The genres to return guide information for.", | |
| "IsRequired": false, | |
| "Name": "Genres", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The genres to return guide information for.", | |
| "IsRequired": false, | |
| "Name": "GenreIds", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available live tv epgs.." | |
| } | |
| }, | |
| "/LiveTv/Programs/Recommended": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user id.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Filter by programs that are currently airing, or not.", | |
| "IsRequired": false, | |
| "Name": "IsAiring", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Filter by programs that have completed airing, or not.", | |
| "IsRequired": false, | |
| "Name": "HasAired", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsSeries", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsMovie", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for news.", | |
| "IsRequired": false, | |
| "Name": "IsNews", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for kids.", | |
| "IsRequired": false, | |
| "Name": "IsKids", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for sports.", | |
| "IsRequired": false, | |
| "Name": "IsSports", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The genres to return guide information for.", | |
| "IsRequired": false, | |
| "Name": "GenreIds", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available live tv epgs.." | |
| } | |
| }, | |
| "/LiveTv/Programs/{Id}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Program Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a live tv program" | |
| } | |
| }, | |
| "/LiveTv/Recordings": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by channel id.", | |
| "IsRequired": false, | |
| "Name": "ChannelId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user and attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by recording status.", | |
| "IsRequired": false, | |
| "Name": "Status", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by recordings that are in progress, or not.", | |
| "IsRequired": false, | |
| "Name": "Status", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by recordings belonging to a series timer", | |
| "IsRequired": false, | |
| "Name": "SeriesTimerId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets live tv recordings" | |
| } | |
| }, | |
| "/LiveTv/Recordings/Folders": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user and attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets recording folders" | |
| } | |
| }, | |
| "/LiveTv/Recordings/Groups": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user and attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets live tv recording groups" | |
| } | |
| }, | |
| "/LiveTv/Recordings/Groups/{Id}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Recording group Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a recording group" | |
| } | |
| }, | |
| "/LiveTv/Recordings/Series": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by channel id.", | |
| "IsRequired": false, | |
| "Name": "ChannelId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by user and attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by recording group.", | |
| "IsRequired": false, | |
| "Name": "GroupId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by recording status.", | |
| "IsRequired": false, | |
| "Name": "Status", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by recordings that are in progress, or not.", | |
| "IsRequired": false, | |
| "Name": "Status", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by recordings belonging to a series timer", | |
| "IsRequired": false, | |
| "Name": "SeriesTimerId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets live tv recordings" | |
| } | |
| }, | |
| "/LiveTv/Recordings/{Id}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Recording Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a live tv recording" | |
| }, | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Recording Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional attach user data.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a live tv recording" | |
| } | |
| }, | |
| "/LiveTv/SeriesTimers": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Sort by SortName or Priority", | |
| "IsRequired": false, | |
| "Name": "SortBy", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Sort in Ascending or Descending order", | |
| "IsRequired": false, | |
| "Name": "SortOrder", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| } | |
| ], | |
| "summary": "Gets live tv series timers" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates a live tv series timer" | |
| } | |
| }, | |
| "/LiveTv/SeriesTimers/{Id}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Timer Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Cancels a live tv series timer" | |
| }, | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Timer Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a live tv series timer" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates a live tv series timer" | |
| } | |
| }, | |
| "/LiveTv/Timers": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by channel id.", | |
| "IsRequired": false, | |
| "Name": "ChannelId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by timers belonging to a series timer", | |
| "IsRequired": false, | |
| "Name": "SeriesTimerId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets live tv timers" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates a live tv timer" | |
| } | |
| }, | |
| "/LiveTv/Timers/Defaults": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional, to attach default values based on a program.", | |
| "IsRequired": false, | |
| "Name": "ProgramId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets default values for a new timer" | |
| } | |
| }, | |
| "/LiveTv/Timers/{Id}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Timer Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Cancels a live tv timer" | |
| }, | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Timer Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a live tv timer" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates a live tv timer" | |
| } | |
| }, | |
| "/LiveTv/TunerHosts": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Tuner host id", | |
| "IsRequired": false, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a tuner host" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Adds a tuner host" | |
| } | |
| }, | |
| "/LiveTv/TunerHosts/Types": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/LiveTv/Tuners/Discvover": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/LiveTv/Tuners/{Id}/Reset": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Tuner Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Resets a tv tuner" | |
| } | |
| }, | |
| "/Localization/Countries": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets known countries" | |
| } | |
| }, | |
| "/Localization/Cultures": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets known cultures" | |
| } | |
| }, | |
| "/Localization/Options": { | |
| "GET": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets localization options" | |
| } | |
| }, | |
| "/Localization/ParentalRatings": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets known parental ratings" | |
| } | |
| }, | |
| "/Movies/Recommendations": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "int", | |
| "Description": "The max number of categories to return", | |
| "IsRequired": false, | |
| "Name": "CategoryLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The max number of items to return per category", | |
| "IsRequired": false, | |
| "Name": "ItemLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The dlna device profile id to utilize.", | |
| "IsRequired": false, | |
| "Name": "DeviceProfileId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets movie recommendations" | |
| } | |
| }, | |
| "/Movies/{Id}/Similar": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Finds movies and trailers similar to a given movie." | |
| } | |
| }, | |
| "/MusicGenres": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all music genres from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/MusicGenres/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The genre Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Creates an instant playlist based on a music genre" | |
| } | |
| }, | |
| "/MusicGenres/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The genre name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The maximum image width to return.", | |
| "IsRequired": false, | |
| "Name": "MaxWidth", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The maximum image height to return.", | |
| "IsRequired": false, | |
| "Name": "MaxHeight", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The fixed image width to return.", | |
| "IsRequired": false, | |
| "Name": "Width", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The fixed image height to return.", | |
| "IsRequired": false, | |
| "Name": "Height", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional quality setting, from 0-100. Defaults to 90 and should suffice in most cases.", | |
| "IsRequired": false, | |
| "Name": "Quality", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Supply the cache tag from the item object to receive strong caching headers.", | |
| "IsRequired": false, | |
| "Name": "Tag", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Specify if whitespace should be cropped out of the image. True/False. If unspecified, whitespace will be cropped from logos and clear art.", | |
| "IsRequired": false, | |
| "Name": "CropWhitespace", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Enable or disable image enhancers such as cover art.", | |
| "IsRequired": false, | |
| "Name": "EnableImageEnhancers", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Determines the output foramt of the image - original,gif,jpg,png", | |
| "IsRequired": false, | |
| "Name": "Format", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Add a played indicator", | |
| "IsRequired": false, | |
| "Name": "AddPlayedIndicator", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional percent to render for the percent played overlay", | |
| "IsRequired": false, | |
| "Name": "PercentPlayed", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional unplayed count overlay to render", | |
| "IsRequired": false, | |
| "Name": "UnplayedCount", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Apply a background color for transparent images.", | |
| "IsRequired": false, | |
| "Name": "BackgroundColor", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Apply a foreground layer on top of the image.", | |
| "IsRequired": false, | |
| "Name": "ForegroundLayer", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Image Type", | |
| "IsRequired": true, | |
| "Name": "Type", | |
| "ParameterType": "path", | |
| "Verb": "GET,POST,DELETE" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Image Index", | |
| "IsRequired": false, | |
| "Name": "Index", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST,DELETE" | |
| } | |
| ], | |
| "summary": "Gets a music genre, by name" | |
| } | |
| }, | |
| "/MusicGenres/{Name}/Images/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/MusicGenres/{Name}/Images/{Type}/{Index}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/MusicGenres/{Name}/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The genre name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Creates an instant playlist based on a music genre" | |
| } | |
| }, | |
| "/Packages": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional package type filter (System/UserInstalled)", | |
| "IsRequired": false, | |
| "Name": "PackageType", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Filter by target system type. Allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "TargetSystems", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional. Filter by premium status", | |
| "IsRequired": false, | |
| "Name": "IsPremium", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional. Filter by package that contain adult content.", | |
| "IsRequired": false, | |
| "Name": "IsAdult", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets available packages" | |
| } | |
| }, | |
| "/Packages/Installed/{Name}": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Package name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Guid of the associated assembly", | |
| "IsRequired": false, | |
| "Name": "AssemblyGuid", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional version. Defaults to latest version.", | |
| "IsRequired": false, | |
| "Name": "Version", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional update class (Dev, Beta, Release). Defaults to Release.", | |
| "IsRequired": false, | |
| "Name": "UpdateClass", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Installs a package" | |
| } | |
| }, | |
| "/Packages/Installing/{Id}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Installation Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Cancels a package installation" | |
| } | |
| }, | |
| "/Packages/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the package", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The guid of the associated assembly", | |
| "IsRequired": false, | |
| "Name": "AssemblyGuid", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a package, by name or assembly guid" | |
| } | |
| }, | |
| "/Persons": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all persons from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Persons/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The person name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a person, by name" | |
| } | |
| }, | |
| "/Persons/{Name}/Images/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Persons/{Name}/Images/{Type}/{Index}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Playback/BitrateTest": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "int", | |
| "Description": "Size", | |
| "IsRequired": true, | |
| "Name": "Size", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Playlists": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the new playlist.", | |
| "IsRequired": false, | |
| "Name": "Name", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Item Ids to add to the playlist", | |
| "IsRequired": false, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The playlist media type", | |
| "IsRequired": false, | |
| "Name": "MediaType", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Creates a new playlist" | |
| } | |
| }, | |
| "/Playlists/{Id}/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates an instant playlist based on a given playlist" | |
| } | |
| }, | |
| "/Playlists/{Id}/Items": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "EntryIds", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Removes items from a playlist" | |
| }, | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets the original items of a playlist" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item id, comma delimited", | |
| "IsRequired": true, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Adds items to a playlist" | |
| } | |
| }, | |
| "/Playlists/{Id}/Items/{ItemId}/Move/{NewIndex}": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "ItemId", | |
| "IsRequired": true, | |
| "Name": "ItemId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "NewIndex", | |
| "IsRequired": true, | |
| "Name": "NewIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Moves a playlist item" | |
| } | |
| }, | |
| "/Plugins": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a list of currently installed plugins" | |
| } | |
| }, | |
| "/Plugins/RegistrationRecords/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": true, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Feature Name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets registration status for a feature" | |
| } | |
| }, | |
| "/Plugins/SecurityInfo": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Gets plugin registration information" | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Updates plugin registration information" | |
| } | |
| }, | |
| "/Plugins/{Id}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Plugin Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Uninstalls a plugin" | |
| } | |
| }, | |
| "/Plugins/{Id}/Configuration": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Plugin Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a plugin's configuration" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Plugin Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates a plugin's configuration" | |
| } | |
| }, | |
| "/Providers/Subtitles/Subtitles/{Id}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Registrations/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": true, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Feature Name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets registration status for a feature" | |
| } | |
| }, | |
| "/ScheduledTasks": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter tasks that are hidden, or not.", | |
| "IsRequired": false, | |
| "Name": "IsHidden", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter tasks that are enabled, or not.", | |
| "IsRequired": false, | |
| "Name": "IsEnabled", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets scheduled tasks" | |
| } | |
| }, | |
| "/ScheduledTasks/Running/{Id}": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Stops a scheduled task" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Starts a scheduled task" | |
| } | |
| }, | |
| "/ScheduledTasks/{Id}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a scheduled task, by Id" | |
| } | |
| }, | |
| "/ScheduledTasks/{Id}/Triggers": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates the triggers for a scheduled task" | |
| } | |
| }, | |
| "/Search/Hints": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Supply a user id to search within a user's library or omit to search all.", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The search term to filter on", | |
| "IsRequired": true, | |
| "Name": "SearchTerm", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "IsRequired": false, | |
| "Name": "IncludePeople", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "IsRequired": false, | |
| "Name": "IncludeMedia", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "IsRequired": false, | |
| "Name": "IncludeGenres", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "IsRequired": false, | |
| "Name": "IncludeStudios", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "IsRequired": false, | |
| "Name": "IncludeArtists", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "IncludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "ExcludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "MediaTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsMovie", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for movies.", | |
| "IsRequired": false, | |
| "Name": "IsSeries", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for news.", | |
| "IsRequired": false, | |
| "Name": "IsNews", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for kids.", | |
| "IsRequired": false, | |
| "Name": "IsKids", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter for sports.", | |
| "IsRequired": false, | |
| "Name": "IsSports", | |
| "ParameterType": "query", | |
| "Verb": "GET,POST" | |
| } | |
| ], | |
| "summary": "Gets search hints based on a search term" | |
| } | |
| }, | |
| "/Sessions": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by sessions that a given user is allowed to remote control.", | |
| "IsRequired": false, | |
| "Name": "ControllableByUserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by device id.", | |
| "IsRequired": false, | |
| "Name": "DeviceId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a list of sessions" | |
| } | |
| }, | |
| "/Sessions/Capabilities": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "A list of playable media types, comma delimited. Audio, Video, Book, Photo.", | |
| "IsRequired": false, | |
| "Name": "PlayableMediaTypes", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "A list of supported remote control commands, comma delimited", | |
| "IsRequired": false, | |
| "Name": "SupportedCommands", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Determines whether media can be played remotely.", | |
| "IsRequired": false, | |
| "Name": "SupportsMediaControl", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Determines whether sync is supported.", | |
| "IsRequired": false, | |
| "Name": "SupportsSync", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Determines whether the device supports a unique identifier.", | |
| "IsRequired": false, | |
| "Name": "SupportsPersistentIdentifier", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates capabilities for a device" | |
| } | |
| }, | |
| "/Sessions/Capabilities/Full": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates capabilities for a device" | |
| } | |
| }, | |
| "/Sessions/Logout": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports that a session has ended" | |
| } | |
| }, | |
| "/Sessions/Playing": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports playback has started within a session" | |
| } | |
| }, | |
| "/Sessions/Playing/Ping": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlaySessionId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Pings a playback session" | |
| } | |
| }, | |
| "/Sessions/Playing/Progress": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports playback progress within a session" | |
| } | |
| }, | |
| "/Sessions/Playing/Stopped": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Reports playback has stopped within a session" | |
| } | |
| }, | |
| "/Sessions/{Id}/Command": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Issues a system command to a client" | |
| } | |
| }, | |
| "/Sessions/{Id}/Command/{Command}": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The command to send.", | |
| "IsRequired": true, | |
| "Name": "Command", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Issues a system command to a client" | |
| } | |
| }, | |
| "/Sessions/{Id}/Message": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The message text.", | |
| "IsRequired": true, | |
| "Name": "Text", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The message header.", | |
| "IsRequired": true, | |
| "Name": "Header", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The message timeout. If omitted the user will have to confirm viewing the message.", | |
| "IsRequired": false, | |
| "Name": "TimeoutMs", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Issues a command to a client to display a message to the user" | |
| } | |
| }, | |
| "/Sessions/{Id}/Playing": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Instructs a session to play an item" | |
| } | |
| }, | |
| "/Sessions/{Id}/Playing/{Command}": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Issues a playstate command to a client" | |
| } | |
| }, | |
| "/Sessions/{Id}/System/{Command}": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The command to send.", | |
| "IsRequired": true, | |
| "Name": "Command", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Issues a system command to a client" | |
| } | |
| }, | |
| "/Sessions/{Id}/Users/{UserId}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "UserId Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Removes an additional user from a session" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "UserId Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Adds an additional user to a session" | |
| } | |
| }, | |
| "/Sessions/{Id}/Viewing": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Session Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The type of item to browse to.", | |
| "IsRequired": true, | |
| "Name": "ItemType", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The Id of the item.", | |
| "IsRequired": true, | |
| "Name": "ItemId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The name of the item.", | |
| "IsRequired": true, | |
| "Name": "ItemName", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Instructs a session to browse to an item or view" | |
| } | |
| }, | |
| "/Shows/NextUp": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by series id", | |
| "IsRequired": false, | |
| "Name": "SeriesId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a list of next up episodes" | |
| } | |
| }, | |
| "/Shows/Upcoming": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a list of upcoming episodes" | |
| } | |
| }, | |
| "/Shows/{Id}/Episodes": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The series id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional filter by season number.", | |
| "IsRequired": false, | |
| "Name": "Season", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by season id", | |
| "IsRequired": false, | |
| "Name": "SeasonId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are missing episodes or not.", | |
| "IsRequired": false, | |
| "Name": "IsMissing", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Return items that are siblings of a supplied item.", | |
| "IsRequired": false, | |
| "Name": "AdjacentTo", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Skip through the list until a given item is found.", | |
| "IsRequired": false, | |
| "Name": "StartItemId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify one or more sort orders, comma delimeted. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime", | |
| "IsRequired": false, | |
| "Name": "SortBy", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Sort Order - Ascending,Descending", | |
| "IsRequired": false, | |
| "Name": "SortOrder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets episodes for a tv season" | |
| } | |
| }, | |
| "/Shows/{Id}/Seasons": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The series id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional. Filter by special season.", | |
| "IsRequired": false, | |
| "Name": "IsSpecialSeason", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by items that are missing episodes or not.", | |
| "IsRequired": false, | |
| "Name": "IsMissing", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Return items that are siblings of a supplied item.", | |
| "IsRequired": false, | |
| "Name": "AdjacentTo", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets seasons for a tv series" | |
| } | |
| }, | |
| "/Shows/{Id}/Similar": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Finds tv shows similar to a given one." | |
| } | |
| }, | |
| "/Songs/{Id}/InstantMix": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Creates an instant playlist based on a given song" | |
| } | |
| }, | |
| "/Startup/Complete": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Reports that the startup wizard has been completed" | |
| } | |
| }, | |
| "/Startup/Configuration": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Gets initial server configuration" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Updates initial server configuration" | |
| } | |
| }, | |
| "/Startup/RemoteAccess": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Updates initial server configuration" | |
| } | |
| }, | |
| "/Startup/User": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Gets initial user info" | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": true, | |
| "members": [], | |
| "summary": "Updates initial user info" | |
| } | |
| }, | |
| "/Studios": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all studios from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Studios/{Name}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The studio name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a studio, by name" | |
| } | |
| }, | |
| "/Studios/{Name}/Images/{Type}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Studios/{Name}/Images/{Type}/{Index}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item name", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/System/ActivityLog/Entries": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The record index to start at. All items with a lower index will be dropped from the results.", | |
| "IsRequired": false, | |
| "Name": "StartIndex", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The minimum date. Format = ISO", | |
| "IsRequired": false, | |
| "Name": "MinDate", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets activity log entries" | |
| } | |
| }, | |
| "/System/Configuration": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets application configuration" | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates application configuration" | |
| } | |
| }, | |
| "/System/Configuration/MetadataOptions/Default": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a default MetadataOptions object" | |
| } | |
| }, | |
| "/System/Configuration/{Key}": { | |
| "GET": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Key", | |
| "IsRequired": true, | |
| "Name": "Key", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a named configuration" | |
| }, | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Key", | |
| "IsRequired": true, | |
| "Name": "Key", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Updates named configuration" | |
| } | |
| }, | |
| "/System/Endpoint": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets information about the request endpoint" | |
| } | |
| }, | |
| "/System/Info": { | |
| "GET": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true, | |
| "EscapeParentalControl": true | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets information about the server" | |
| } | |
| }, | |
| "/System/Info/Public": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets public information about the server" | |
| } | |
| }, | |
| "/System/Logs": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a list of available server log files" | |
| } | |
| }, | |
| "/System/Logs/Log": { | |
| "GET": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "The log file name.", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a log file" | |
| } | |
| }, | |
| "/System/MediaEncoder/Path": { | |
| "POST": { | |
| "authenticated": { | |
| "AllowBeforeStartupWizard": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Path", | |
| "IsRequired": true, | |
| "Name": "Path", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "PathType", | |
| "IsRequired": true, | |
| "Name": "PathType", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates the path to the media encoder" | |
| } | |
| }, | |
| "/System/Ping": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/System/Restart": { | |
| "POST": { | |
| "authenticated": { | |
| "AllowLocal": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Restarts the application, if needed" | |
| } | |
| }, | |
| "/System/Shutdown": { | |
| "POST": { | |
| "authenticated": { | |
| "AllowLocal": true, | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Shuts down the application" | |
| } | |
| }, | |
| "/System/WakeOnLanInfo": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets wake on lan information" | |
| } | |
| }, | |
| "/Trailers": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Finds movies and trailers similar to a given trailer." | |
| } | |
| }, | |
| "/Trailers/{Id}/Similar": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Finds movies and trailers similar to a given trailer." | |
| } | |
| }, | |
| "/Users": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by IsHidden=true or false", | |
| "IsRequired": false, | |
| "Name": "IsHidden", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by IsDisabled=true or false", | |
| "IsRequired": false, | |
| "Name": "IsDisabled", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Optional filter by IsGuest=true or false", | |
| "IsRequired": false, | |
| "Name": "IsGuest", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a list of users" | |
| } | |
| }, | |
| "/Users/AuthenticateByName": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Username", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Password", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Pw", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Authenticates a user" | |
| } | |
| }, | |
| "/Users/ForgotPassword": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "EnteredUsername", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Initiates the forgot password process for a local user" | |
| } | |
| }, | |
| "/Users/ForgotPassword/Pin": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "Pin", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Redeems a forgot password pin" | |
| } | |
| }, | |
| "/Users/New": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Name", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "Password", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Creates a user" | |
| } | |
| }, | |
| "/Users/Public": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a list of publicly visible users for display on a login screen." | |
| } | |
| }, | |
| "/Users/{Id}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "User Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a user" | |
| }, | |
| "GET": { | |
| "authenticated": { | |
| "EscapeParentalControl": true | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "User Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a user by Id" | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates a user" | |
| } | |
| }, | |
| "/Users/{Id}/Authenticate": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "User Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Pw", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "Password", | |
| "ParameterType": "body", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Authenticates a user" | |
| } | |
| }, | |
| "/Users/{Id}/Configuration": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "User Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates a user configuration" | |
| } | |
| }, | |
| "/Users/{Id}/EasyPassword": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates a user's easy password" | |
| } | |
| }, | |
| "/Users/{Id}/Images/{Type}": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Users/{Id}/Images/{Type}/{Index}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": null | |
| }, | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| }, | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Users/{Id}/Password": { | |
| "POST": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Updates a user's password" | |
| } | |
| }, | |
| "/Users/{Id}/Policy": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "IsRequired": true, | |
| "Name": "User Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates a user policy" | |
| } | |
| }, | |
| "/Users/{UserId}/FavoriteItems/{Id}": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Unmarks an item as a favorite" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Marks an item as a favorite" | |
| } | |
| }, | |
| "/Users/{UserId}/GroupingOptions": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Users/{UserId}/Items": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets items based on a query." | |
| } | |
| }, | |
| "/Users/{UserId}/Items/Latest": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Limit", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Specify this to localize the search to a specific item or folder. Omit to use the root", | |
| "IsRequired": false, | |
| "Name": "ParentId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, SortName, Studios, Taglines", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimeted.", | |
| "IsRequired": false, | |
| "Name": "IncludeItemTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Filter by items that are folders, or not.", | |
| "IsRequired": false, | |
| "Name": "IsFolder", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Filter by items that are played, or not.", | |
| "IsRequired": false, | |
| "Name": "IsPlayed", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "Whether or not to group items into a parent container.", | |
| "IsRequired": false, | |
| "Name": "GroupItems", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets latest media" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/Resume": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets items based on a query." | |
| } | |
| }, | |
| "/Users/{UserId}/Items/Root": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets the root folder from a user's library" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/{Id}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets an item from a user's library" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/{Id}/Intros": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets intros to play before the main media item plays" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/{Id}/LocalTrailers": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets local trailers for an item" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/{Id}/Rating": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes a user's saved personal rating for an item" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Whether the user likes the item or not. true/false", | |
| "IsRequired": true, | |
| "Name": "Likes", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Updates a user's rating for an item" | |
| } | |
| }, | |
| "/Users/{UserId}/Items/{Id}/SpecialFeatures": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Movie Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets special features for an item" | |
| } | |
| }, | |
| "/Users/{UserId}/PlayedItems/{Id}": { | |
| "DELETE": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Marks an item as unplayed" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The date the item was played (if any). Format = yyyyMMddHHmmss", | |
| "IsRequired": false, | |
| "Name": "DatePlayed", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Marks an item as played" | |
| } | |
| }, | |
| "/Users/{UserId}/PlayingItems/{Id}": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the MediaSource", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The next media type that will play", | |
| "IsRequired": true, | |
| "Name": "NextMediaType", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms", | |
| "IsRequired": false, | |
| "Name": "PositionTicks", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "LiveStreamId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlaySessionId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports that a user has stopped playing an item" | |
| }, | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the MediaSource", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Indicates if the client can seek", | |
| "IsRequired": false, | |
| "Name": "CanSeek", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "IsRequired": false, | |
| "Name": "AudioStreamIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "IsRequired": false, | |
| "Name": "SubtitleStreamIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlayMethod", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "LiveStreamId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlaySessionId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports that a user has begun playing an item" | |
| } | |
| }, | |
| "/Users/{UserId}/PlayingItems/{Id}/Progress": { | |
| "POST": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The id of the MediaSource", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The current position, in ticks. 1 tick = 10000 ms", | |
| "IsRequired": false, | |
| "Name": "PositionTicks", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Indicates if the player is paused.", | |
| "IsRequired": false, | |
| "Name": "IsPaused", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Indicates if the player is muted.", | |
| "IsRequired": false, | |
| "Name": "IsMuted", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "IsRequired": false, | |
| "Name": "AudioStreamIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "IsRequired": false, | |
| "Name": "SubtitleStreamIndex", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Scale of 0-100", | |
| "IsRequired": false, | |
| "Name": "VolumeLevel", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlayMethod", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "LiveStreamId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "PlaySessionId", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "IsRequired": false, | |
| "Name": "RepeatMode", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| } | |
| ], | |
| "summary": "Reports a user's playback progress" | |
| } | |
| }, | |
| "/Users/{UserId}/Suggestions": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets items based on a query." | |
| } | |
| }, | |
| "/Users/{UserId}/Views": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "User Id", | |
| "IsRequired": true, | |
| "Name": "UserId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Whether or not to include external views such as channels or live tv", | |
| "IsRequired": true, | |
| "Name": "IncludeExternalContent", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/ActiveEncodings": { | |
| "DELETE": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "The device id of the client requesting. Used to stop encoding processes when needed.", | |
| "IsRequired": true, | |
| "Name": "DeviceId", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "The play session id", | |
| "IsRequired": true, | |
| "Name": "PlaySessionId", | |
| "ParameterType": "query", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/MergeVersions": { | |
| "POST": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Item id list. This allows multiple, comma delimited.", | |
| "IsRequired": false, | |
| "Name": "Ids", | |
| "ParameterType": "query", | |
| "Verb": "POST" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include image information in output", | |
| "IsRequired": false, | |
| "Name": "EnableImages", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "boolean", | |
| "Description": "Optional, include user data", | |
| "IsRequired": false, | |
| "Name": "EnableUserData", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional, the max number of images to return, per image type", | |
| "IsRequired": false, | |
| "Name": "ImageTypeLimit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. The image types to include in the output.", | |
| "IsRequired": false, | |
| "Name": "EnableImageTypes", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "Optional. The maximum number of records to return", | |
| "IsRequired": false, | |
| "Name": "Limit", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "AllowMultiple": true, | |
| "DataType": "string", | |
| "Description": "Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls", | |
| "IsRequired": false, | |
| "Name": "Fields", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Merges videos into a single record" | |
| } | |
| }, | |
| "/Videos/{Id}/AdditionalParts": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets additional parts for a video." | |
| } | |
| }, | |
| "/Videos/{Id}/AlternateSources": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Removes alternate video sources." | |
| } | |
| }, | |
| "/Videos/{Id}/Subtitles/{Index}": { | |
| "DELETE": { | |
| "authenticated": { | |
| "Roles": "Admin" | |
| }, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The subtitle stream index", | |
| "IsRequired": true, | |
| "Name": "Index", | |
| "ParameterType": "path", | |
| "Verb": "DELETE" | |
| } | |
| ], | |
| "summary": "Deletes an external subtitle file" | |
| } | |
| }, | |
| "/Videos/{Id}/hls/{PlaylistId}/stream.m3u8": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/hls/{PlaylistId}/{SegmentId}.{SegmentContainer}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/hls1/{PlaylistId}/{SegmentId}.{SegmentContainer}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/live.m3u8": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/main.m3u8": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a video stream using HTTP live streaming." | |
| } | |
| }, | |
| "/Videos/{Id}/master.m3u8": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a video stream using HTTP live streaming." | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets a video stream using HTTP live streaming." | |
| } | |
| }, | |
| "/Videos/{Id}/stream": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.3gp": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.asf": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.avi": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.flv": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.iso": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.m2ts": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.m4v": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mkv": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mov": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mp4": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mpeg": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mpegts": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.mpg": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.ogv": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.rm": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.ts": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.webm": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/stream.wtv": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| }, | |
| "HEAD": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": null | |
| } | |
| }, | |
| "/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/Stream.{Format}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets subtitles in a specified format." | |
| } | |
| }, | |
| "/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/subtitles.m3u8": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "MediaSourceId", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The subtitle stream index", | |
| "IsRequired": true, | |
| "Name": "Index", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The subtitle srgment length", | |
| "IsRequired": true, | |
| "Name": "SegmentLength", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets an HLS subtitle playlist." | |
| } | |
| }, | |
| "/Videos/{Id}/{MediaSourceId}/Subtitles/{Index}/{StartPositionTicks}/Stream.{Format}": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "string", | |
| "Description": "Item Id", | |
| "IsRequired": true, | |
| "Name": "Id", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "MediaSourceId", | |
| "IsRequired": true, | |
| "Name": "MediaSourceId", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "int", | |
| "Description": "The subtitle stream index", | |
| "IsRequired": true, | |
| "Name": "Index", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Format", | |
| "IsRequired": true, | |
| "Name": "Format", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "StartPositionTicks", | |
| "IsRequired": false, | |
| "Name": "StartPositionTicks", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "EndPositionTicks", | |
| "IsRequired": false, | |
| "Name": "EndPositionTicks", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "bool", | |
| "Description": "CopyTimestamps", | |
| "IsRequired": false, | |
| "Name": "CopyTimestamps", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets subtitles in a specified format." | |
| } | |
| }, | |
| "/Years": { | |
| "GET": { | |
| "authenticated": false, | |
| "hidden": false, | |
| "members": [], | |
| "summary": "Gets all years from a given item, folder, or the entire library" | |
| } | |
| }, | |
| "/Years/{Year}": { | |
| "GET": { | |
| "authenticated": {}, | |
| "hidden": false, | |
| "members": [ | |
| { | |
| "DataType": "int", | |
| "Description": "The year", | |
| "IsRequired": true, | |
| "Name": "Year", | |
| "ParameterType": "path", | |
| "Verb": "GET" | |
| }, | |
| { | |
| "DataType": "string", | |
| "Description": "Optional. Filter by user id, and attach user data", | |
| "IsRequired": false, | |
| "Name": "UserId", | |
| "ParameterType": "query", | |
| "Verb": "GET" | |
| } | |
| ], | |
| "summary": "Gets a year" | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment