travel.izi.api.service

Interface CityService

public interface CityService

Endpoints for City.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getChildrenNumber(java.lang.String uuid, java.lang.String[] languages) Get the number of City’s children (museums, tours).
FullMtgObject	getCity(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full City object by UUID.
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 City children in compact form.
java.util.List<CompactMtgObject>	getCompactCities(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Boolean visible, java.lang.Long limit, java.lang.Long offset) Get list of compact City objects which have content on requested languages.
FullMtgObject	getCountry(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full Country object by City.
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 City children in full form.
java.util.List<FullMtgObject>	getFullCities(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Boolean visible, java.lang.Long limit, java.lang.Long offset) Get list of full City objects which have content on requested languages.

Method Detail

getCompactCities

@GET(value="/cities?form=compact")
java.util.List<CompactMtgObject> getCompactCities(@Query(value="languages")
                                                                                     java.lang.String[] languages,
                                                                                     @Query(value="includes")
                                                                                     java.lang.String[] includes,
                                                                                     @Query(value="except")
                                                                                     java.lang.String[] except,
                                                                                     @Query(value="visible")
                                                                                     java.lang.Boolean visible,
                                                                                     @Query(value="limit")
                                                                                     java.lang.Long limit,
                                                                                     @Query(value="offset")
                                                                                     java.lang.Long offset)

Get list of compact City objects which have content on requested languages.

Parameters:

languages - Array of languages which should have city.

includes - Array of sections which should be included to city object.

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

visible - If it equals to 'true', then returns cities marked as visible only.

limit - Limit for pagination, defaults to 20.

offset - Offset for pagination, defaults to 0.

Returns:

City objects which have content on requested languages. Returns empty list of there are no matched cities.

See Also:

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

getFullCities

@GET(value="/cities?form=full")
java.util.List<FullMtgObject> getFullCities(@Query(value="languages")
                                                                            java.lang.String[] languages,
                                                                            @Query(value="includes")
                                                                            java.lang.String[] includes,
                                                                            @Query(value="except")
                                                                            java.lang.String[] except,
                                                                            @Query(value="visible")
                                                                            java.lang.Boolean visible,
                                                                            @Query(value="limit")
                                                                            java.lang.Long limit,
                                                                            @Query(value="offset")
                                                                            java.lang.Long offset)

Get list of full City objects which have content on requested languages.

See Also:

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

getCity

@GET(value="/cities/{uuid}")
FullMtgObject getCity(@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 City object by UUID.

Parameters:

uuid - UUID of the City.

languages - Array of languages which should have city.

includes - Array of sections which should be included to city object.

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

Returns:

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

getCompactChildren

@GET(value="/cities/{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 City children in compact form.

Parameters:

uuid - UUID of the City.

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

includes - Array of sections which should be included into response.

except - Array of sections which should NOT be included into response.

limit - Limit for pagination, defaults to 20.

offset - Offset for pagination, defaults to 0.

Returns:

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

See Also:

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

getFullChildren

@GET(value="/cities/{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 City children in full form.

See Also:

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

getChildrenNumber

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

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

Parameters:

uuid - UUID of the City.

languages - Array of preferable content languages.

Returns:

Number of children of requested City on requested languages (returned as an integer).

getCountry

@GET(value="/cities/{uuid}/country")
FullMtgObject getCountry(@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 Country object by City.

Parameters:

uuid - UUID of the City.

languages - Array of languages which should have city.

includes - Array of sections which should be included to country object.

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

Returns:

Country object or 404 HTTP code if there is no City with provided UUID or City does not have Country.