travel.izi.api.service

Interface PublisherService

public interface PublisherService

Endpoints for Publisher.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getChildrenCount(java.lang.String uuid, java.lang.String[] languages) Get the number of Publisher’s children (museums, tours)
java.util.List<CompactMtgObject>	getCompactChildren(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset) Get Publisher children in compact form.
java.util.List<FullMtgObject>	getFullChildren(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset, java.lang.Boolean children_count) Get Publisher children in full form.
java.util.List<java.lang.String>	getLanguages(java.lang.String uuid, java.lang.String[] languages) Get Publisher languages by UUID, i.e.
FullMtgObject	getPublisher(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full Publisher object by UUID.

Method Detail

getPublisher

@GET(value="/mtg/publishers/{uuid}")
FullMtgObject getPublisher(@Path(value="uuid")
                                                                java.lang.String uuid,
                                                                @Query(value="languages")
                                                                java.lang.String[] languages,
                                                                @Query(value="includes")
                                                                java.lang.String[] includes,
                                                                @Query(value="except")
                                                                java.lang.String[] except)

Get full Publisher object by UUID.

Parameters:

uuid - UUID of the Publisher.

languages - Array of languages which should have Publisher.

includes - Array of sections which should be included to Publisher.

except - Array of sections which should NOT be included to Publisher.

Returns:

Publisher or 404 HTTP code if there is no Publisher with provided UUID.

getCompactChildren

@GET(value="/mtg/publishers/{uuid}/children?form=compact")
java.util.List<CompactMtgObject> getCompactChildren(@Path(value="uuid")
                                                                                                               java.lang.String uuid,
                                                                                                               @Query(value="languages")
                                                                                                               java.lang.String[] languages,
                                                                                                               @Query(value="includes")
                                                                                                               java.lang.String[] includes,
                                                                                                               @Query(value="except")
                                                                                                               java.lang.String[] except,
                                                                                                               @Query(value="limit")
                                                                                                               java.lang.Long limit,
                                                                                                               @Query(value="offset")
                                                                                                               java.lang.Long offset)

Get Publisher children in compact form.

Parameters:

uuid - UUID of the Publisher.

languages - Array of requested languages, i.e. Publisher's children should have one of the requested languages.

includes - Array of sections which should be included.

except - Array of sections which should NOT be included.

limit - Limit for pagination, defaults to 20.

offset - Offset for pagination, defaults to 0.

Returns:

Tours and Museums which belongs to the Publisher. Returns 404 HTTP code if there is no Publisher with provided UUID.

See Also:

getFullChildren(String, String[], String[], String[], Long, Long, Boolean)

getFullChildren

@GET(value="/mtg/publishers/{uuid}/children?form=full")
java.util.List<FullMtgObject> getFullChildren(@Path(value="uuid")
                                                                                                      java.lang.String uuid,
                                                                                                      @Query(value="languages")
                                                                                                      java.lang.String[] languages,
                                                                                                      @Query(value="includes")
                                                                                                      java.lang.String[] includes,
                                                                                                      @Query(value="except")
                                                                                                      java.lang.String[] except,
                                                                                                      @Query(value="limit")
                                                                                                      java.lang.Long limit,
                                                                                                      @Query(value="offset")
                                                                                                      java.lang.Long offset,
                                                                                                      @Query(value="children_count_in_full_form")
                                                                                                      java.lang.Boolean children_count)

Get Publisher children in full form.

See Also:

getCompactChildren(String, String[], String[], String[], Long, Long)

getChildrenCount

@GET(value="/mtg/publishers/{uuid}/children/count")
java.lang.Integer getChildrenCount(@Path(value="uuid")
                                                                                       java.lang.String uuid,
                                                                                       @Query(value="languages")
                                                                                       java.lang.String[] languages)

Get the number of Publisher’s children (museums, tours)

Parameters:

uuid - UUID of the Publisher.

languages - Array of requested languages. Publisher’s children should have one of the requested languages.

Returns:

Number of children (tours and museums).

getLanguages

@GET(value="/mtg/publishers/{uuid}/children/languages")
java.util.List<java.lang.String> getLanguages(@Path(value="uuid")
                                                                                                      java.lang.String uuid,
                                                                                                      @Query(value="languages")
                                                                                                      java.lang.String[] languages)

Get Publisher languages by UUID, i.e. returns list of unique languages on which Publisher have content.

Parameters:

uuid - UUID of the Publisher.

languages - Array of requested languages. The resulting list of languages to be contained in this array.

Returns:

List of languages.