com.uwetrottmann.tmdb2.services.FindService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tmdb-java Show documentation

tmdb-java is a retrofit2 based wrapper around the themoviedb.org API v3.

The newest version!

package com.uwetrottmann.tmdb2.services;

import com.uwetrottmann.tmdb2.entities.FindResults;
import com.uwetrottmann.tmdb2.enumerations.ExternalSource;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Path;
import retrofit2.http.Query;

public interface FindService {

    /**
     * The find method makes it easy to search for objects in our database by an external id. For instance, an IMDB ID.
     * This will search all objects (movies, TV shows and people) and return the results in a single response. TV season
     * and TV episode searches will be supported shortly.
     *
     * @param externalId An External Media Object Id.
     * @param source     Required. An External source to search. Allowed Values: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
     * @param language   Optional. ISO 639-1 code.
     */
    @GET("find/{external_id}")
    Call find(
            @Path("external_id") String externalId,
            @Query("external_source") ExternalSource source,
            @Query("language") String language
    );

    /**
     * The find method makes it easy to search for objects in our database by an external id. For instance, an IMDB ID.
     * This will search all objects (movies, TV shows and people) and return the results in a single response. TV season
     * and TV episode searches will be supported shortly.
     *
     * @param externalId An External Media Object Id.
     * @param source     Required. An External source to search. Allowed Values: imdb_id, freebase_mid, freebase_id, tvdb_id, tvrage_id
     * @param language   Optional. ISO 639-1 code.
     */
    @GET("find/{external_id}")
    Call find(
            @Path("external_id") int externalId,
            @Query("external_source") ExternalSource source,
            @Query("language") String language
    );

}