it.polimi.dima.mediatracker.external_services.rest_interfaces

Interface VideogameRestInterface

public interface VideogameRestInterface

REST interface to communicate with the videogames external service API

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FIELD_LIST

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<VideogameJSON>	getVideogameInfo(java.lang.String gameId, java.lang.String apiKey) Get data for a specific videogame
retrofit2.Call<VideogameSearchJSON>	searchVideogames(java.lang.String query, int maxResults, java.lang.String apiKey) Searches videogames

Field Detail

FIELD_LIST

static final java.lang.String FIELD_LIST

See Also:

Constant Field Values

Method Detail

searchVideogames

@GET(value="search?format=json&resources=game")
retrofit2.Call<VideogameSearchJSON> searchVideogames(@Query(value="query")
                                                                                                      java.lang.String query,
                                                                                                      @Query(value="limit")
                                                                                                      int maxResults,
                                                                                                      @Query(value="api_key")
                                                                                                      java.lang.String apiKey)

Searches videogames

Parameters:

query - the title to search

maxResults - max number of results

apiKey - the service API key

Returns:

a search JSON representation

getVideogameInfo

@GET(value="game/{gameId}/?format=json&field_list=id,original_release_date,expected_release_day,expected_release_month,expected_release_year,genres,name,deck,developers,publishers,platforms,image")
retrofit2.Call<VideogameJSON> getVideogameInfo(@Path(value="gameId")
                                                                                                                                                                                                                                                      java.lang.String gameId,
                                                                                                                                                                                                                                                      @Query(value="api_key")
                                                                                                                                                                                                                                                      java.lang.String apiKey)

Get data for a specific videogame

Parameters:

gameId - the ID of the videogame

apiKey - the service API key

Returns:

the videogame JSON representation