Search-Api.md

Search API

The following search services are available as part of the SDK bundled by default –

Auto Suggest

The Autosuggest API helps users to complete queries faster by adding intelligent search capabilities to your web or mobile app. This API returns a list of results as well as suggested queries as the user types in the search field.

MapplsGL.RestApi.autoSuggest({
    query: text,
}).then(response => {
    //Handle Response
}).catche(error => {
    //Handle Error
});

Request Parameter

Mandatory Parameter

1. query(String): e.g. Shoes, Coffee, Versace, Gucci, H&M, Adidas, Starbucks, B130 {POI, House Number, keyword, tag}.

Optional Parameter

1. filter(String):This parameter helps you restrict the result either by mentioning a bounded area or to certain mapplspin (6 digit code to any poi, locality, city, etc.) below mentioned are the various types:
   • filter = bounds: lat1, lng1; lat2, lng2 (latitude, longitude) {e.g. filter: "bounds:28.598882,77.212407;28.467375,77.353513"}
   • filter = cop: {mapplspin} (string) {e.g. filter: "cop:YMCZ0J"}
2. pod(String): it takes in the place type code which helps in restricting the results to certain chosen type. Below mentioned are the codes for the pod
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_SUB_LOCALITY: Sublocality
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_LOCALITY: Locality
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_CITY: City
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_VILLAGE: Village
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_SUB_DISTRICT: Subdistrict
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_DISTRICT: District
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_STATE: State
   • MapplsGL.RestApi.AutoSuggestCriteria.POD_SUB_SUB_LOCALITY: Subsublocality
3. location(Location): e.g. location: {latitude: 28.454, longitude: 77.435}
4. tokenizeAddress(boolean): provides the different address attributes in a structured object.
5. zoom(double): takes the zoom level of the current scope of the map (min: 4, max: 18).
6. hyperLocal(boolean): This parameter lets the search give results that are hyper-localized to the reference location passed in the location parameter. This means that nearby results are given a higher ranking than results far from the reference location. Highly prominent results will still appear in the search results, however they will be lower in the list of results. This parameter will work ONLY in conjunction with the location parameter.

Response Parameter

1. suggestedLocations(Array<ELocation>: A List of the suggested location
2. userAddedLocations(Array<ELocation>): List of usr added locations
3. suggestedSearches(Array<SuggestedSearchAtlas>): List of suggestion related to your search.

ELocation Response Result Parameter

1. mapplsPin(String): Mappls Pin of the location 6-char alphanumeric.
2. placeAddress(String):Address of the location.
3. type(String): type of location POI or Country or City
4. placeName(string): Name of the location.
5. addressTokens(AddressTokens)
6. orderIndex(number): the order where this result should be placed
7. distance(number): aerial distance in meters from reference location

AddressTokens Response Result parameter

1. houseNumber(string): house number of the location.
2. houseName(string): house name of the location.
3. poi(string): name of the POI (if applicable)
4. street(string): name of the street. (if applicable)
5. subSubLocality(string): the sub-sub-locality to which the location belongs. (if applicable)
6. subLocality(string): the sub-locality to which the location belongs. (if applicable)
7. locality(string): the locality to which the location belongs. (if applicable)
8. village(string): the village to which the location belongs. (if applicable)
9. subDistrict(string): the sub-district to which the location belongs. (if applicable)
10. district(string): the district to which the location belongs. (if applicable)
11. city(string): the city to which the location belongs. (if applicable)
12. state(string): the state to which the location belongs. (if applicable)
13. pincode(string): the PIN code to which the location belongs. (if applicable)

SuggestedSearchAtlas Result Response parameter

1. keyword(string): what the user typed in.
2. identifier(string): what did the API use for it to qualify it as a suggested search request
3. location(string): the name of the location to which the nearby will run in context to.
4. hyperLink(string): the ready-made link for the nearby API pre-initialized with all default parameters and location with code to search for.

Geocode

Our Geocoding API converts real addresses into these geographic coordinates (latitude/longitude) to be placed on a map, be it for any street, area, postal code, POI or a house number etc.

MapplsGL.RestApi.geocode({address: placeName})
    .then(response => {
        //Handle Response
    })
    .catch(error => {
        //Handle Error
    });

Request Parameter

Mandatory Parameters

1. address(string): address to be geocoded e.g. 237 Okhla industrial estate phase 3 new delhi, delhi 110020.

Optional Parameters

1. itemCount(number): parameter can be set to get maximum number of result items from the API (default: 1).

Response Parameter

1. results(Array<GeoCode>): All the details regarding place.

GeoCode Result Response parameter

1. houseNumber(string): the houseNumber of the address/location
2. houseName(string): houseName of the address/location
3. poi(string): the point of interest or famous landmark nearby the location
4. street(string): the street or road of the location
5. subSubLocality(string): the subSubLocality of the location
6. subLocality(string): the subLocality of the location
7. locality(string): the locality of the location
8. village(string): the village of the location
9. subDistrict(string): the subDistrict of the location
10. district(string): the district of the location
11. city(string): the city of the location
12. state(string): the state of the location
13. pincode(string): the pincode of the location
14. formattedAddress(string): the general protocol following address
15. mapplsPin(string): mappls pin of the particular location
16. latitude(number): the latitude for the location.
17. longitude(number): the longitude for the location.
18. geocodeLevel(string): the best matched address component.

Reverse Geocode

Reverse Geocoding is a process to give the closest matching address to a provided geographical coordinates (latitude/longitude). Mappls reverse geocoding API provides real addresses along with nearest popular landmark for any such geo-positions on the map.

 MapplsGL.RestApi.reverseGeocode({latitude: lat, longitude: lng})
      .then(response => {
        // Handle Response
      })
      .catch(error => {
        // Handle Error
      });

Request Parameter

1. latitude(number): the latitude of the location for which the address is required.
2. longitude(number): the longitude of the location for which the address is required.

Response Paramter

1. responseCode(number): Response codes of the api.
2. version(string): Version of the Api.
3. results(Array<Place>): All the details regarding place.

Place Result Response parameter

1. houseNumber(string): the houseNumber of the address/location
2. houseName(string): houseName of the address/location
3. poi(string): the point of interest or famous landmark nearby the location
4. poi_dist(string): distance from nearest POI in metres.
5. street(string): the street or road of the location
6. street_dist(string): distance from nearest Street in metres.
7. subSubLocality(string): the subSubLocality of the location
8. subLocality(string): the subLocality of the location
9. locality(string): the locality of the location
10. village(string): the village of the location
11. district(string): the district of the location
12. subDistrict(string): the subDistrict of the location
13. city(string): the city of the location
14. state(string): the state of the location
15. pincode(string): the pincode of the location
16. formatted_address(string): the general protocol following address
17. area(string): the area of the location.

Nearby Places

Nearby Places API, enables you to add discovery and search of nearby POIs by searching for a generic keyword used to describe a category of places or via the unique code assigned to that category.

MapplsGL.RestApi.nearby({
      keyword: keyword,
      location: location
    }) .then(response => {
        // Handle Response
      })
      .catch(error => {
        // Handle Error
      });

Request Parameters

Mandatory Parameters

1. keyword(string): performs search on the basis of provided keyword For eg: coffee, EV Charging Station etc
2. location(string): Provide the location around which the search will be performed
   • location also support mappls pin e.g., location: "MMI000"

Optional parameters

1. page(number): provides number of the page to provide results from.
2. radius(number): provides the range of distance to search over(default: 1000, min: 500, max: 10000)
3. pod(string): it takes in the place type code which helps in restricting the results to certain chosen type. Access to this parameter is controlled from the backend. This parameter if provided will override any values provided in keywords request param.
4. bounds(string): Allows the developer to send in map bounds to provide a nearby search within the bounds. {e.g. (bounds: "28.56812,77.240519;28.532790,77.290854")
5. filter(string):This parameter helps you get a specific type of EV charging Station
   • filter = model:(string);brandId:(string);plugType:(string)
6. richData(boolean): rich data related to poi
7. sortBy(string): provides configured sorting operations for the client on cloud. Below are the available sorts:
   • MapplsGL.RestApi.NearbyCriteria.DISTANCE_ASCENDING
   • MapplsGL.RestApi.NearbyCriteria.DISTANCE_DESCENDING
   • MapplsGL.RestApi.NearbyCriteria.NAME_ASCENDING
   • MapplsGL.RestApi.NearbyCriteria.NAME_DESCENDING
8. userName(string): Use to set the user name

Response Parameter

1. suggestedLocations(Array<NearbyAtlasResult>): List of nearby places
2. pageInfo(PageInfo)

NearbyAtlasResult Response parameter

1. distance(number): provides the distance from the provided location bias in meters.
2. mapplsPin(string): Place Id of the location 6-char alphanumeric.
3. email(string): Email for contact.
4. keywords(Array<string>): provides an array of matched keywords or codes.
5. landlineNo(string): Email for contact.
6. mobileNo(string): Phone number for contact.
7. orderIndex(string): the order where this result should be placed
8. placeAddress(string): Address of the location.
9. placeName(string): Name of the location.
10. type(string): Type of location POI or Country or City.
11. city(string): City of the location
12. state(string): State of the location
13. pincode(string): Pincode of the location
14. hourOfOperation(string): The hours of operation of the POI in a day.
15. addressTokens(AddressTokens)

AddressTokens Response Result parameter

1. houseNumber(string): house number of the location.
2. houseName(string): house name of the location.
3. poi(string): name of the POI (if applicable)
4. street(string): name of the street. (if applicable)
5. subSubLocality(string): the sub-sub-locality to which the location belongs. (if applicable)
6. subLocality(string): the sub-locality to which the location belongs. (if applicable)
7. locality(string): the locality to which the location belongs. (if applicable)
8. village(string): the village to which the location belongs. (if applicable)
9. subDistrict(string): the sub-district to which the location belongs. (if applicable)
10. district(string): the district to which the location belongs. (if applicable)
11. city(string): the city to which the location belongs. (if applicable)
12. state(string): the state to which the location belongs. (if applicable)
13. pincode(string): the PIN code to which the location belongs. (if applicable)

PageInfo Response Result Parameter

1. pageCount(number): The number of pages with results.
2. totalHits(number): Total number of places in the results.
3. totalPages(number): Total number of pages as per page size and no of results.
4. pageSize(number): The number of results per page.

Place Details

Mappls Place Details is a simple, standardized and precise pan-India digital address system. Every location has been assigned a unique digital address or an mapplsPin. The mapplsPin API can be used to extract the details of a place with the help of its mapplsPinn i.e. a 6 digit code or a place_id.

MapplsGL.RestApi.placeDetail(
    {mapplsPin: "MMI000"}
    ).then(response => {
        // Handle Response
      })
      .catch(error => {
        // Handle Error
      });

Request Parameters

Mandatory Parameter

1. mapplsPin(string): the id or mapplsPin of the place whose details are required. The 6-digit alphanumeric code for any location. (e.g. mmi000).

Response Parameters

1. mapplsPin(string): 6 characters alphanumeric unique identifier
2. latitude(number): The latitude of the location.
3. longitude(number): The longitude of the location.

Note: Not all response parameters are available by default. These parameters are restricted and available as per the discussed use case. For details, please contact Mappls API support.

POI Along the Route

With POI Along the Route API user will be able to get the details of POIs of a particular category along his set route. The main focus of this API is to provide convenience to the user and help him in locating the place of his interest on his set route.

MapplsGL.RestApi.POIAlongRoute({
      path: path,
      category: keyword,
      buffer: 300,
      geometries: 'polyline6',
      page: 1,
    }).then(response => {
        // Handle Response
      })
      .catch(error => {
        // Handle Error
      });

Request Parameter

Mandatory Parameter

1. category(string): The POI category code to be searched. Only one category input supported.
2. path(string): This parameter takes the encoded route along which POIs to be searched.

Optional Paramter

1. buffer(number): Buffer of the road. Minimum value is 25, maximum is 1000 and default is 25.
2. geometries(string): Type of geometry encoding.
3. page(number): Used for pagination. By default, a request returns maximum 10 results and to get the next 10 or so on pass the page value accordingly. Default is 1.
4. sort(boolean): Gets the sorted POIs along route.

Response Parameter

1. suggestedPOIs(Array<SuggestedPOI>): List of Suggested POI location

SuggestedPOI Response parameter

1. distance(number): distance of the POI.
2. mapplsPin(string): mapplsPin of the POI.
3. poi(string): Name of the POI.
4. subSubLocality(string): Sub sub locality of the POI.
5. subLocality(string): Sub locality of the POI.
6. locality(string): Locality of the POI.
7. city(string): City of the POI.
8. subDistrict(string): Sub district of the POI.
9. district(string): District of the POI.
10. state(string): State of the POI.
11. poplrName(string): Popular name of the POI.
12. address(string): Address of the POI.
13. tel(string): Telephone number of the POI.
14. email(string): Email of the POI.
15. website(string): Website of the POI.
16. brand_code(string): Brand id of the POI.

For any queries and support, please contact:

Email us at [email protected]

Support Need support? contact us!

@ Copyright 2022 CE Info Systems Ltd. All Rights Reserved.

Terms & Conditions | Privacy Policy | Supplier Sustainability Policy | Health & Safety Policy | Environmental Policy & CSR Report

Customer Care: +91-9999333223