Skip to content

Latest commit

 

History

History
204 lines (110 loc) · 5.7 KB

MoviesApi.md

File metadata and controls

204 lines (110 loc) · 5.7 KB
Raw

\MoviesApi

All URIs are relative to https://api4.thetvdb.com/v4

Method HTTP request Description
get_all_movie GET /movies
get_movie_base GET /movies/{id}
get_movie_base_by_slug GET /movies/slug/{slug}
get_movie_extended GET /movies/{id}/extended
get_movie_translation GET /movies/{id}/translations/{language}
get_movies_filter GET /movies/filter

get_all_movie

crate::models::GetAllMovie200Response get_all_movie(page)

returns list of movie base records

Parameters

Name Type Description Required Notes
page Option<f32> page number

Return type

crate::models::GetAllMovie200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_movie_base

crate::models::GetMovieBase200Response get_movie_base(id)

Returns movie base record

Parameters

Name Type Description Required Notes
id f32 id [required]

Return type

crate::models::GetMovieBase200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_movie_base_by_slug

crate::models::GetMovieBase200Response get_movie_base_by_slug(slug)

Returns movie base record search by slug

Parameters

Name Type Description Required Notes
slug String slug [required]

Return type

crate::models::GetMovieBase200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_movie_extended

crate::models::GetMovieExtended200Response get_movie_extended(id, meta, short)

Returns movie extended record

Parameters

Name Type Description Required Notes
id f32 id [required]
meta Option<String> meta
short Option<bool> reduce the payload and returns the short version of this record without characters, artworks and trailers.

Return type

crate::models::GetMovieExtended200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_movie_translation

crate::models::GetEpisodeTranslation200Response get_movie_translation(id, language)

Returns movie translation record

Parameters

Name Type Description Required Notes
id f32 id [required]
language String language [required]

Return type

crate::models::GetEpisodeTranslation200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_movies_filter

crate::models::GetMoviesFilter200Response get_movies_filter(country, lang, company, content_rating, genre, sort, status, year)

Search movies based on filter parameters

Parameters

Name Type Description Required Notes
country String country of origin [required]
lang String original language [required]
company Option<f32> production company
content_rating Option<f32> content rating id base on a country
genre Option<f32> genre
sort Option<String> sort by results
status Option<f32> status
year Option<f32> release year

Return type

crate::models::GetMoviesFilter200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]