All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| get_episodes | GET /Shows/{seriesId}/Episodes | Gets episodes for a tv season. |
| get_next_up | GET /Shows/NextUp | Gets a list of next up episodes. |
| get_seasons | GET /Shows/{seriesId}/Seasons | Gets seasons for a tv series. |
| get_upcoming_episodes | GET /Shows/Upcoming | Gets a list of upcoming episodes. |
crate::models::BaseItemDtoQueryResult get_episodes(series_id, user_id, fields, season, season_id, is_missing, adjacent_to, start_item_id, start_index, limit, enable_images, image_type_limit, enable_image_types, enable_user_data, sort_by) Gets episodes for a tv season.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| series_id | uuid::Uuid | The series id. | [required] | |
| user_id | Option<uuid::Uuid> | The user id. | ||
| fields | Option<Veccrate::models::ItemFields> | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. | ||
| season | Option<i32> | Optional filter by season number. | ||
| season_id | Option<uuid::Uuid> | Optional. Filter by season id. | ||
| is_missing | Option<bool> | Optional. Filter by items that are missing episodes or not. | ||
| adjacent_to | Option<String> | Optional. Return items that are siblings of a supplied item. | ||
| start_item_id | Option<uuid::Uuid> | Optional. Skip through the list until a given item is found. | ||
| start_index | Option<i32> | Optional. The record index to start at. All items with a lower index will be dropped from the results. | ||
| limit | Option<i32> | Optional. The maximum number of records to return. | ||
| enable_images | Option<bool> | Optional, include image information in output. | ||
| image_type_limit | Option<i32> | Optional, the max number of images to return, per image type. | ||
| enable_image_types | Option<Veccrate::models::ImageType> | Optional. The image types to include in the output. | ||
| enable_user_data | Option<bool> | Optional. Include user data. | ||
| sort_by | Option<String> | Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime. |
crate::models::BaseItemDtoQueryResult
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::BaseItemDtoQueryResult get_next_up(user_id, start_index, limit, fields, series_id, parent_id, enable_images, image_type_limit, enable_image_types, enable_user_data, next_up_date_cutoff, enable_total_record_count, disable_first_episode, enable_rewatching) Gets a list of next up episodes.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | Option<uuid::Uuid> | The user id of the user to get the next up episodes for. | ||
| start_index | Option<i32> | Optional. The record index to start at. All items with a lower index will be dropped from the results. | ||
| limit | Option<i32> | Optional. The maximum number of records to return. | ||
| fields | Option<Veccrate::models::ItemFields> | Optional. Specify additional fields of information to return in the output. | ||
| series_id | Option<String> | Optional. Filter by series id. | ||
| parent_id | Option<uuid::Uuid> | Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. | ||
| enable_images | Option<bool> | Optional. Include image information in output. | ||
| image_type_limit | Option<i32> | Optional. The max number of images to return, per image type. | ||
| enable_image_types | Option<Veccrate::models::ImageType> | Optional. The image types to include in the output. | ||
| enable_user_data | Option<bool> | Optional. Include user data. | ||
| next_up_date_cutoff | Option<String> | Optional. Starting date of shows to show in Next Up section. | ||
| enable_total_record_count | Option<bool> | Whether to enable the total records count. Defaults to true. | [default to true] | |
| disable_first_episode | Option<bool> | Whether to disable sending the first episode in a series as next up. | [default to false] | |
| enable_rewatching | Option<bool> | Whether to include watched episode in next up results. | [default to false] |
crate::models::BaseItemDtoQueryResult
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::BaseItemDtoQueryResult get_seasons(series_id, user_id, fields, is_special_season, is_missing, adjacent_to, enable_images, image_type_limit, enable_image_types, enable_user_data) Gets seasons for a tv series.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| series_id | uuid::Uuid | The series id. | [required] | |
| user_id | Option<uuid::Uuid> | The user id. | ||
| fields | Option<Veccrate::models::ItemFields> | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls. | ||
| is_special_season | Option<bool> | Optional. Filter by special season. | ||
| is_missing | Option<bool> | Optional. Filter by items that are missing episodes or not. | ||
| adjacent_to | Option<String> | Optional. Return items that are siblings of a supplied item. | ||
| enable_images | Option<bool> | Optional. Include image information in output. | ||
| image_type_limit | Option<i32> | Optional. The max number of images to return, per image type. | ||
| enable_image_types | Option<Veccrate::models::ImageType> | Optional. The image types to include in the output. | ||
| enable_user_data | Option<bool> | Optional. Include user data. |
crate::models::BaseItemDtoQueryResult
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::BaseItemDtoQueryResult get_upcoming_episodes(user_id, start_index, limit, fields, parent_id, enable_images, image_type_limit, enable_image_types, enable_user_data) Gets a list of upcoming episodes.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | Option<uuid::Uuid> | The user id of the user to get the upcoming episodes for. | ||
| start_index | Option<i32> | Optional. The record index to start at. All items with a lower index will be dropped from the results. | ||
| limit | Option<i32> | Optional. The maximum number of records to return. | ||
| fields | Option<Veccrate::models::ItemFields> | Optional. Specify additional fields of information to return in the output. | ||
| parent_id | Option<uuid::Uuid> | Optional. Specify this to localize the search to a specific item or folder. Omit to use the root. | ||
| enable_images | Option<bool> | Optional. Include image information in output. | ||
| image_type_limit | Option<i32> | Optional. The max number of images to return, per image type. | ||
| enable_image_types | Option<Veccrate::models::ImageType> | Optional. The image types to include in the output. | ||
| enable_user_data | Option<bool> | Optional. Include user data. |
crate::models::BaseItemDtoQueryResult
- Content-Type: Not defined
- Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase
[Back to top] [Back to API list] [Back to Model list] [Back to README]