Package com.github.m0nk3y2k4.thetvdb.api

Interface TheTVDBApi.JSON

  • Enclosing interface:
    TheTVDBApi
    public static interface TheTVDBApi.JSON
    Interface representing the API's JSON layout.


    This layout may be used if you do not want any post-processing being applied to the actual remote service response data. All methods within this layout will return the raw, unmodified JSON data as it was received from the API. This might be useful if you prefer to map the JSON data yourself, want to use your own Java data models or if you don't want to parse the JSON data at all (but forward it to some other service for example). This layout does not provide any shortcut-methods though.

    See Also:
    TheTVDBApi.json()

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.fasterxml.jackson.databind.JsonNode addToFavorites​(long seriesId)
      Adds the supplied series ID to the user’s favorite’s list and returns the updated list as raw JSON.
      com.fasterxml.jackson.databind.JsonNode addToRatings​(String itemType, long itemId, long itemRating)
      Updates a given rating of a given type and returns the modified rating, mapped as raw JSON.
      com.fasterxml.jackson.databind.JsonNode deleteFromFavorites​(long seriesId)
      Deletes the given series ID from the user’s favorite’s list and returns the updated list as raw JSON.
      com.fasterxml.jackson.databind.JsonNode deleteFromRatings​(String itemType, long itemId)
      Deletes a given rating of a given type.
      com.fasterxml.jackson.databind.JsonNode filterSeries​(long seriesId, QueryParameters queryParameters)
      Returns a filtered series record based on the given parameters, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getActors​(long seriesId)
      Returns the actors for a specific series as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableEpisodeQueryParameters​(long seriesId)
      Returns a list of keys which are valid parameters for querying episodes, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableImageQueryParameters​(long seriesId)
      Returns a list of valid parameters for querying a series images, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableLanguages()
      Returns an overview of all supported languages as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableLastUpdatedQueryParameters()
      Returns a list of valid parameters for querying series which have been updated lately, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableRatingsQueryParameters()
      Returns a list of valid parameters for querying user ratings, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableSeriesFilterParameters​(long seriesId)
      Returns a list of keys which are valid parameters for filtering series, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getAvailableSeriesSearchParameters()
      Returns possible query parameters, which can be used to search for series, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getEpisode​(long episodeId)
      Returns the full information for a given episode id as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getEpisodes​(long seriesId, QueryParameters queryParameters)
      Returns all episodes of a specific series as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getFavorites()
      Returns an array of favorite series for a given user, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getLanguage​(long languageId)
      Returns further language information for a given language ID as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getMovie​(long movieId)
      Returns detailed information for a specific movie as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getMovieUpdates​(long since)
      Returns a list of ID's of all movies, that have been updated since the given epoch timestamp, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getRatings()
      Returns a list of ratings for the given user, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getSeries​(long seriesId)
      Returns detailed information for a specific series as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getSeriesEpisodesSummary​(long seriesId)
      Returns a summary of the episodes and seasons available for a series, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getSeriesHeaderInformation​(long seriesId)
      Returns header information for a specific series as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getSeriesImagesSummary​(long seriesId)
      Returns a summary of the images types and counts available for a particular series, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode getUser()
      Returns basic information about the currently authenticated user, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode queryEpisodes​(long seriesId, QueryParameters queryParameters)
      Returns all matching episodes of a specific series as raw JSON.
      com.fasterxml.jackson.databind.JsonNode queryImages​(long seriesId, QueryParameters queryParameters)
      Returns the matching result of querying images for a specific series, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode queryLastUpdated​(QueryParameters queryParameters)
      Returns an array of series that have changed in a maximum of one week blocks since the provided fromTime query parameter, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode queryRatings​(QueryParameters queryParameters)
      Returns a list of ratings for a given user that match the query, as raw JSON.
      com.fasterxml.jackson.databind.JsonNode searchSeries​(QueryParameters queryParameters)
      Returns series search results based on the given query parameters as raw JSON.