travel.izi.api.service

Interface CountryService

public interface CountryService

Endpoints for Country.

Method Summary

Modifier and Type	Method and Description
<any>	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 Country children in compact form.
<any>	getCompactCities(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 list of compact City objects which belong to the Country with requested UUID.
<any>	getCompactCountries(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset) Get list of compact Country objects which have content on requested languages.
<any>	getCountry(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full Country object by UUID.
<any>	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 Country children in full form.
<any>	getFullCities(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 list of full City objects which belong to the Country with requested UUID.
<any>	getFullCountries(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.Long limit, java.lang.Long offset) Get list of full Country objects which have content on requested languages.

Method Detail

getCompactCountries

<any> getCompactCountries(java.lang.String[] languages,
                          java.lang.String[] includes,
                          java.lang.String[] except,
                          java.lang.Long limit,
                          java.lang.Long offset)

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

Parameters:

languages - Array of languages which should have country.

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

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

limit - Limit for pagination, defaults to 20.

offset - Offset for pagination, defaults to 0.

Returns:

List of countries which have content on requested languages. Returns empty list of there are no matched countries.

See Also:

getFullCountries(String[], String[], String[], Long, Long)

getFullCountries

<any> getFullCountries(java.lang.String[] languages,
                       java.lang.String[] includes,
                       java.lang.String[] except,
                       java.lang.Long limit,
                       java.lang.Long offset)

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

See Also:

getCompactCountries(String[], String[], String[], Long, Long)

getCountry

<any> getCountry(java.lang.String uuid,
                 java.lang.String[] languages,
                 java.lang.String[] includes,
                 java.lang.String[] except)

Get full Country object by UUID.

Parameters:

uuid - UUID of the Country.

languages - Array of languages which should have country.

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 or 404 HTTP code if there is no Country with provided UUID.

getCompactChildren

<any> 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 Country children in compact form.

Parameters:

uuid - UUID of the Country.

languages - Array of requested languages, i.e. Country'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 country. Returns 404 HTTP code if there is no Country with provided UUID.

See Also:

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

getFullChildren

<any> 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 Country children in full form.

See Also:

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

getCompactCities

<any> getCompactCities(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 list of compact City objects which belong to the Country with requested UUID.

Parameters:

uuid - UUID of the Country.

languages - Array of requested languages, each Country's City should have content at one of the requested language.

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

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

limit - Limit for pagination, defaults to 20.

offset - Offset for pagination, defaults to 0.

Returns:

List of cities which belong to requested Country and have content on requested languages object or 404 HTTP code if there is no Country with provided UUID.

See Also:

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

getFullCities

<any> getFullCities(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 list of full City objects which belong to the Country with requested UUID.

See Also:

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