travel.izi.api.service

Interface SearchService

public interface SearchService

Endpoints for Search.

Method Summary

Modifier and Type

Method and Description

<any>

search(java.lang.String[] languages, java.lang.String[] publishers, 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.Integer rating_min, java.lang.Integer rating_max) Search all over IZI.directory content.

Method Detail

search

<any> search(java.lang.String[] languages,
             java.lang.String[] publishers,
             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.Integer rating_min,
             java.lang.Integer rating_max)

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 alphabetically.

   /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.

publishers - Array of Publishers UUID’s. Defines a limit (filter) to make search in certain Publishers.

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

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

types - List of requested types of objects, defaults are `tour`, `museum`. Applicable values: `museum`, `tour`, `city`, `country`, `collection`, `tourist_attraction`, `story_navigation` and `quest`. `quest` type can be used to filter tours with playback type quest only, if the type parameter will keep `tour` and `quest` values, the `quest` will be ignored and tours with any playback types will be filtered.

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 `rating`, `popularity` and `title`. 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.

rating_min - Filters content with rating equal or greater than `rating_min`, integer values [0..10].

rating_max - Filters content with rating equal or less than `rating_max`, integer values [0..10].

Returns:

List of various MtgObjects(Museum, Tour, City, Country, etc). Integer, String, Integer, String, String, Long, Long, Boolean)