it.polimi.dima.mediatracker.external_services.rest_interfaces

Interface TVShowRestInterface

public interface TVShowRestInterface

REST interface to communicate with the TV shows external service API

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<TVShowJSON>	getTVShowInfo(java.lang.String tvShowId, java.lang.String apiKey) Get data for a specific TV show
retrofit2.Call<TVShowSeasonJSON>	getTVShowNextEpisodeDate(java.lang.String tvShowId, int lastSeasonNumber, java.lang.String apiKey) Retrieves the next episode date for a given TV show
retrofit2.Call<TVShowSearchJSON>	searchTVShows(java.lang.String query, java.lang.String apiKey) Searches TV shows

Method Detail

searchTVShows

@GET(value="search/tv/?")
retrofit2.Call<TVShowSearchJSON> searchTVShows(@Query(value="query")
                                                                          java.lang.String query,
                                                                          @Query(value="api_key")
                                                                          java.lang.String apiKey)

Searches TV shows

Parameters:

query - the title to search

apiKey - the service API key

Returns:

a search JSON representation

getTVShowInfo

@GET(value="tv/{tvShowId}?")
retrofit2.Call<TVShowJSON> getTVShowInfo(@Path(value="tvShowId")
                                                                       java.lang.String tvShowId,
                                                                       @Query(value="api_key")
                                                                       java.lang.String apiKey)

Get data for a specific TV show

Parameters:

tvShowId - the ID of the TV show

apiKey - the service API key

Returns:

the TV show JSON representation

getTVShowNextEpisodeDate

@GET(value="tv/{tvShowId}/season/{lastSeasonNumber}?")
retrofit2.Call<TVShowSeasonJSON> getTVShowNextEpisodeDate(@Path(value="tvShowId")
                                                                                                                  java.lang.String tvShowId,
                                                                                                                  @Path(value="lastSeasonNumber")
                                                                                                                  int lastSeasonNumber,
                                                                                                                  @Query(value="api_key")
                                                                                                                  java.lang.String apiKey)

Retrieves the next episode date for a given TV show

Parameters:

tvShowId - the ID of the TV show

lastSeasonNumber - the number of the last season

apiKey - the service API key

Returns:

a TV show season JSON representation