travel.izi.api.service

Interface CountryService

public interface CountryService

Endpoints for Country.

Method Summary

Modifier and Type	Method and Description
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 Country children in compact form.
java.util.List<CompactMtgObject>	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.
java.util.List<CompactMtgObject>	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.
FullMtgObject	getCountry(java.lang.String uuid, java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except) Get full Country object by UUID.
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 Country children in full form.
java.util.List<FullMtgObject>	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.
java.util.List<FullMtgObject>	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

@GET(value="/countries?form=compact")
java.util.List<CompactMtgObject> getCompactCountries(@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 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

@GET(value="/countries?form=full")
java.util.List<FullMtgObject> getFullCountries(@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 list of full Country objects which have content on requested languages.

See Also:

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

getCountry

@GET(value="/countries/{uuid}")
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 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

@GET(value="/countries/{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 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

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

See Also:

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

getCompactCities

@GET(value="/countries/{uuid}/cities?form=compact")
java.util.List<CompactMtgObject> getCompactCities(@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 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

@GET(value="/countries/{uuid}/cities?form=full")
java.util.List<FullMtgObject> getFullCities(@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 list of full City objects which belong to the Country with requested UUID.

See Also:

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