travel.izi.api.service

Interface SearchService

public interface SearchService

Endpoints for Search.

Method Summary

Modifier and Type	Method and Description
java.util.List<CompactMtgObject>	searchCompact(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.String[] types, java.lang.String query, java.lang.String region, java.lang.String lat_lon, java.lang.Integer radius, java.lang.String ex_lat_lon, java.lang.Integer ex_radius, java.lang.String sort_by, java.lang.String cost, java.lang.Long limit, java.lang.Long offset) Search all over IZI.directory content.
java.util.List<FullMtgObject>	searchFull(java.lang.String[] languages, java.lang.String[] includes, java.lang.String[] except, java.lang.String[] types, java.lang.String query, java.lang.String region, java.lang.String lat_lon, java.lang.Integer radius, java.lang.String ex_lat_lon, java.lang.Integer ex_radius, java.lang.String sort_by, java.lang.String cost, java.lang.Long limit, java.lang.Long offset, java.lang.Boolean children_count) Search all over IZI.directory content.

Method Detail

searchCompact

@GET(value="/mtg/objects/search?form=compact")
java.util.List<CompactMtgObject> searchCompact(@Query(value="languages")
                                                                                              java.lang.String[] languages,
                                                                                              @Query(value="includes")
                                                                                              java.lang.String[] includes,
                                                                                              @Query(value="except")
                                                                                              java.lang.String[] except,
                                                                                              @Query(value="type")
                                                                                              java.lang.String[] types,
                                                                                              @Query(value="query")
                                                                                              java.lang.String query,
                                                                                              @Query(value="region")
                                                                                              java.lang.String region,
                                                                                              @Query(value="lat_lon")
                                                                                              java.lang.String lat_lon,
                                                                                              @Query(value="radius")
                                                                                              java.lang.Integer radius,
                                                                                              @Query(value="ex_lat_lon")
                                                                                              java.lang.String ex_lat_lon,
                                                                                              @Query(value="ex_radius")
                                                                                              java.lang.Integer ex_radius,
                                                                                              @Query(value="sort_by")
                                                                                              java.lang.String sort_by,
                                                                                              @Query(value="cost")
                                                                                              java.lang.String cost,
                                                                                              @Query(value="limit")
                                                                                              java.lang.Long limit,
                                                                                              @Query(value="offset")
                                                                                              java.lang.Long offset)

Search all over IZI.directory content. Supports full-text search, area search, transparent sorting and pagination.

Examples:

• Find all cities which have content on English language and sort them by name.

   /mtg/objects/search?languages=en&type=city&sort_by=title
   

• Find all tours, cities and countries which have content on English and Dutch and also have `ams` in their title.

   /mtg/objects/search?languages=en,nl&type=city,country,tour&query=ams
   

• Find all countries which have content on Russian and sort them alpabetically.

   /mtg/objects/search?languages=ru&type=country&sort_by=title
   

• Find all tours with English language, do not include publisher section to results Compact MtgObjects, but include city section.

   /mtg/objects/search?languages=en&type=tour&includes=city&except=publisher
   

Parameters:

languages - Array of languages which should have MtgObject.

includes - Array of ContentSectionModifier which should be included into MtgObject.

except - Array of ContentSectionModifier which should NOT be included into MtgObject.

types - Array of requested MtgObjectType, defaults are `tour`, `museum`.

query - Query for full-text search.

region - UUID of the city or country, limits search by city or country with provided UUID.

lat_lon - Geo location used to sort found MtgObjects from provided point, defaults to 0.0,0.0.

radius - Radius in meters, used only with #lat_lon param to search MtgObjects in area.

ex_lat_lon - Geo location, used only with #ex_radius to exclude from area search certain area.

ex_radius - Radius in meters, used only with #ex_lat_lon to exclude from area search certain area.

sort_by - Sorting field in format 'field:direction', currently possible values are `popularity` and `title`. Default sort order for popularity is desc, whereas default sort order for title is asc. Example, "...&sort_by=title:asc&...". If results keeps `city` or `country` objects in additional to `museum`, `tour`, etc, `country` objects will be returned first, next `city` objects and finally rest of objects. Each set will be sorted according to `sort_by` criteria.

cost - Filtering content by Cost, by default filter is not applied.

limit - Limit, defaults to 50.

offset - Offset, defaults to 0.

Returns:

List of various MtgObjects(Museum, Tour, City, Country, etc).

See Also:

searchFull(String[], String[], String[], String[], String, String, String, Integer, String, Integer, String, String, Long, Long, Boolean)

searchFull

@GET(value="/mtg/objects/search?form=full")
java.util.List<FullMtgObject> searchFull(@Query(value="languages")
                                                                                     java.lang.String[] languages,
                                                                                     @Query(value="includes")
                                                                                     java.lang.String[] includes,
                                                                                     @Query(value="except")
                                                                                     java.lang.String[] except,
                                                                                     @Query(value="type")
                                                                                     java.lang.String[] types,
                                                                                     @Query(value="query")
                                                                                     java.lang.String query,
                                                                                     @Query(value="region")
                                                                                     java.lang.String region,
                                                                                     @Query(value="lat_lon")
                                                                                     java.lang.String lat_lon,
                                                                                     @Query(value="radius")
                                                                                     java.lang.Integer radius,
                                                                                     @Query(value="ex_lat_lon")
                                                                                     java.lang.String ex_lat_lon,
                                                                                     @Query(value="ex_radius")
                                                                                     java.lang.Integer ex_radius,
                                                                                     @Query(value="sort_by")
                                                                                     java.lang.String sort_by,
                                                                                     @Query(value="cost")
                                                                                     java.lang.String cost,
                                                                                     @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)

Search all over IZI.directory content. Supports full-text search, area search, transparent sorting and pagination.

See Also:

searchCompact(String[], String[], String[], String[], String, String, String, Integer, String, Integer, String, String, Long, Long)