travel.izi.api.service

Interface CityService

public interface CityService

Endpoints for City.

Method Summary

Modifier and Type	Method and Description
<any>	childrenNumber(java.lang.String uuid, java.lang.String[] languages) Get the number of City’s children (museums, tours).
<any>	city(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full City object by UUID.
<any>	compactChildren(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.
<any>	compactCities(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.
<any>	country(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full Country object by City.
<any>	fullChildren(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.
<any>	fullCities(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

compactCities

<any> compactCities(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.

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:

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

fullCities

<any> fullCities(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.

See Also:

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

city

<any> city(java.lang.String uuid,
           java.lang.String[] languages,
           java.lang.String[] includes,
           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.

compactChildren

<any> compactChildren(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.

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:

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

fullChildren

<any> fullChildren(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.

See Also:

compactChildren(String, String[], String[], String[], Long, Long)

childrenNumber

<any> childrenNumber(java.lang.String uuid,
                     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).

country

<any> country(java.lang.String uuid,
              java.lang.String[] languages,
              java.lang.String[] includes,
              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.