Note¶
- The response listed in the below documentation is ONLY indicative of the overall capabilities of Mappls's Search APIs.
- Not all response parameters mentioned in the below documentation is assured to be present in all the use-cases. The response of any of the below search API is thus, dependent on the use-case agreed upon between Mappls & it's API consumer.
- For any further clarifications on what all of the response structure is available for your use case, please contact your business relationship manager or contact Mappls API support.
- PREMIUM APIs/Parameters are not available for evalulation on signup. To get access, please contact 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.
Getting Access¶
Before using the API in the your solution, please ensure that the related access is enabled in the Mappls Console, within your app - be it for Mobile OR Web or Cloud integration.
- Copy and paste the key from your
credentials
section from your API keys into theaccess_token
query parameter.- Your static key can be secured by whitelisting its usage for particular IPs (in case of cloud app usage) OR a set of domains (in case of a web app)
- Your static key obtained from your Console is to be passed as a query parameter:
access_token
.
Authentication Object - access_token
mandatory query parameter.¶
access_token
: "hklmgbwzrxncdyavtsuojqpiefrbhqplnm".
Input Method¶
GET/POST
URL¶
https://search.mappls.com/search/places/along-route
Request Parameters¶
The following input parameters will be supported in the POI Along The Route API request
Mandatory Parameters¶
path
(string) This parameter takes the encoded route along which POIs to be searched.category
{string} The POI category code to be searched. Only one category input supported by default. API does have the capability to search across multiple categories simultaneously (PREMIUM
Offering). To access multiple category search, please contact API Support.
Optional Parameters¶
sort
(valueless): Gets the sorted POIs along route as per distance from the origin in meters.geometries
(string): Type of geometry encoding, accepted values arepolyline5
,polyline6
, andbase64
. Default value ispolyline5
.buffer
(number): Buffer of the road in meters. Minimum value is25
, maximum is1000
and default is25
.page
(number): Used for pagination. By default, a request returns maximum10
results and to get the next10
or so on pass the page value accordingly. Default is 1.
Important Note¶
- When using POST method, the parameters are sent as
multipart/form-data
- The length of polyline as input is limited as of now. The API can take in polyline of length not more than 30 kms long. (
PREMIUM
Offering). To access search along larger distances, please contact API Support.
Response Type¶
JSON
Response Codes¶
Note: as HTTP response code
Success¶
- 200: To denote a successful API call.
- 204: To denote the API was a success but no results were found.
Client-Side Issues¶
- 400: Bad Request, User made an error while creating a valid request.
- 401: Unauthorized, Developer’s key is not allowed to send a request with restricted parameters.
- 403: Forbidden, Developer’s key has hit its daily/hourly limit. Server-Side Issues:
- 500: Internal Server Error, the request caused an error in our systems.
- 503: Service Unavailable, during our maintenance break or server down-times.
Response Messages¶
Note: as HTTP response message
- 200: Success.
- 204: No matches we’re found for the provided query.
- 400: Something’s just not right with the request.
- 401: Access Denied.
- 403: Services for this key has been suspended due to daily/hourly transactions limit.
- 500: Something went wrong.
- 503: Maintenance Break.
Reponse Parameters¶
suggestedPOIs ([object array])
distance
(integer): distance of the POI.place_id
(string): eLoc of the POIpoi
(string): Name of the POIsubSubLocality
(string): Subsublocality of the POIsubLocality
(string): Sublocality of the POIlocality
(string): Locality of the POIcity
(string): City of the POIsubDistrict
(string): Sub district of the POIdistrict
(string): District of the POIstate
(string): State of the POIpoplrName
(string): Popular name of the POIaddress
(string): Address of the POItel
(string): Telephone number of the POIemail
(string): Email of the POIwebsite
(string): Website of the POIbrand_code
(string): Brand id of the POIcategory
1 (string): the category code to which this POI belongs to. Comes only when multiple category search is used.
Sample requests¶
cURL for single category search¶
curl --location --request POST 'https://search.mappls.com/search/places/along-route?access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm' \
--form 'geometries=polyline5' \
--form 'path=mfvmDcalvMB?B?@EB}@lABzABrBDAaAFoDFuCFuC@{@@m@DoAFu@D_@VmAFWHSHKBCFCbA]n@S`@IX?^BdAL|ANtCV~ANXBfBDfBBl@Bp@BrA@Pa@FKHMf@@`CHXDLBJFHJHRbD@`D@Z?h@@f@@h@@bAB^@jDDlBB~@BT@N?dDDV?x@Bt@@dCFdCFzB@nD?N?|BEzBEzBE`@AJ?lCOxCMfAClCGnCIlCIlCIhDKfDIhDIzCK|AG|AEbBG`A@d@FVD^FjARlBVn@D`AD|@Fn@DnCZnCZtBTH@J?V@`A@lC@nC@lCB`AGNCTCPEl@SRI|@a@~BqAb@OZGt@E|BEl@AxA?|@?pA@T?V@bCB`AJNBn@L^NpAl@t@`@d@V~BlA`CnA~BnA`A`@VJd@NXF~@JN@xBBL?hA?x@Ar@?x@A@?vCAvCAvCAxCAj@F`@Fd@Nf@RrAn@|@b@dBz@fBz@nBfAJF~Ax@`CfAXLRHp@XtCpAtCrAf@V|@Rf@Px@TxAZ\\F`BL`BLZEPERGNKPQR_@BaBPeEHeAXo@NcDLaDNaDNaDAkB?kAKqDIoD_@mAI{BI{BGgBIgBGiBCm@ASAi@Cu@Cc@Ag@Aa@GgBGgBGkBAu@IeCAUJARARA~@GB?f@C|AK`BIbBIt@IPCPCZO`@[FKLOR]Vk@Pi@DUL{@D[P}CP{C@i@@a@Ae@EiBCiBAyC?_ACaB?QAeBAgB?WB_@BSDSDOTu@dA{Cr@sBRi@JU^q@j@cATYZ_@TUbBsAHIhA}@jA_AlAaA`Ay@bAy@d@c@pAgAv@q@`AcA^_@tAoAVSVQLGdAg@f@Yz@e@W_@KSWIoAuCmAwCLMBCDCNE@AJ?H@F@v@fB\\GNGb@W\\YfAcALI@C@CBADCD@JBDBBBBD@D?DDLBFJNFDHDF@J@|CKbCItAEHCHA@EBEDCDABAF?D@DB@BDH@D?JADL@l@?j@BbAGGcAGiACc@Cm@C[' \
--form 'category=FODCOF' \
--form 'buffer=300' \
--form 'page=1' \
--form 'sort='
cURL for multiple category search¶
curl --location --request POST 'https://search.mappls.com/search/places/along-route?access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm' \
--form 'geometries="polyline5"' \
--form 'path="k{{mDyhlvMD@J?jCJlCRL@|AFt@Af@CTCPCRIh@SnAy@nAw@lBmA|B}ApA_ArA}@Ng@BQDWFg@Oe@W_AGWEe@EgAAyBDcCFaCBsBAc@Cs@Eq@E[EYEWI_@I_@Qq@Oo@EUTKl@UrAm@RG^O~@UzCu@|Cu@|Cu@zCu@lBa@JCPAhACtCDtCBvCBtCBlCBnCDd@?t@@dC?T?fA@tB?tB@VCl@Qt@UPEf@AlDDz@H\\\\?xBK`AEtBCvBAlAB`DPdA^NDL@h@@fACxAE\\\\?~BA~BA~BAtBAL?nBC~@Af@g@HIJQFOBQ@WAUEWISOYOQQMQIOGQASAO@QDMFKJU\\\\_@f@@nC?b@@R?ZFvBDzB@JDlBFxBBbAD~AHhCHzDN^DFDFFFXPbAAT@L@VBH@z@NJDRLlAv@lAx@~AKnAOn@G`@IX?^BdAL|ANtCV~ANXBfBDfBBl@Bp@BrA@Pa@FKHMf@@`CHXDLBJFHJHRbD@`D@Z?h@@f@@h@@bAB^@jDDlBB~@BT@N?dDDV?x@Bt@@dCFdCFzB@nD?N?|BEzBEzBE`@AJ?lCOxCMfAClCGnCIlCIlCIhDKfDIhDIzCK|AG|AEbBG`A@^Sz@e@f@Yr@c@pCgB~@o@~AeA`BcAhA[XQb@_@\\\\YZe@?QBMDMDIDEDEJEDCFAF?"' \
--form 'category="FODCOF;TRNPMP;HOTPRE"' \
--form 'buffer="300"' \
--form 'page="1"' \
--form 'sort=""'
Sample Response¶
{
"suggestedPOIs": [
{
"distance": 760,
"place_id": "TT9FFL",
"poi": "Indian Oil Petrol Pump",
"subSubLocality": "",
"subLocality": "Parda Bagh",
"locality": "Daryaganj",
"city": "New Delhi",
"subDistrict": "Darya Ganj",
"district": "Central District",
"state": "Delhi",
"poplrName": "",
"address": "Elgin Road, Netaji Subhash Marg, New Delhi, Delhi, 110002",
"category": "TRNPMP",
"brand_code": "0"
},
{
"distance": 2833,
"place_id": "2ZU43P",
"poi": "Cafe Coffee Day",
"subSubLocality": "",
"subLocality": "",
"locality": "Indraprastha Estate",
"city": "New Delhi",
"subDistrict": "Darya Ganj",
"district": "Central District",
"state": "Delhi",
"poplrName": "CCD",
"address": "MBD House, Gulab Bhavan, 6, Bhadurshah Zafar Marg, New Delhi, Delhi, 110002",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3232,
"place_id": "WPSIFH",
"poi": "SPA Canteen",
"subSubLocality": "",
"subLocality": "",
"locality": "Indraprastha Estate",
"city": "New Delhi",
"subDistrict": "Darya Ganj",
"district": "Central District",
"state": "Delhi",
"poplrName": "",
"address": "School of Planning and Architecture, Indraprashta Marg, Balmiki Basti, Vikram Nagar, New Delhi, Delhi, 110002",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3705,
"place_id": "E1TFF1",
"poi": "Le Cafe Royal",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "",
"address": "Centre Point, 13, Connaught Place, Kasturba Gandhi Marg, New Delhi, Delhi, 110001",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3741,
"place_id": "2ZVYE1",
"poi": "Cafe Coffee Day",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "CCD",
"address": "44, Janpath, New Delhi, Delhi, 110001",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3743,
"place_id": "Q0RX2E",
"poi": "Cafe Coffee Day",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "CCD",
"address": "Connaught Place, New Delhi, Delhi, 110001",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3744,
"place_id": "B2D6E4",
"poi": "Cafe Coffee Day",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "CCD",
"address": "40/42, Ground Floor, Pearl Sons Pvt Ltd, Opposite To Janpath Market, Janpath Road, Near HDFC Bank, Connaught Place, New Delhi, Delhi, 110001",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3760,
"place_id": "D7S55S",
"poi": "Indian Oil Petrol Pump",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "",
"address": "Tolstoy Marg, Connaught Place, New Delhi, Delhi, 110001",
"category": "TRNPMP",
"brand_code": "0"
},
{
"distance": 3822,
"place_id": "ABC4M2",
"poi": "Cottage Cafe by Smoothie Factory",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "",
"address": "Jawahar Vyapar Bhawan, Cottage Emporium Janpath, Near Monga Handicrafts, New Delhi, Delhi, 110001",
"category": "FODCOF",
"brand_code": "0"
},
{
"distance": 3963,
"place_id": "FBE365",
"poi": "The Imperial New Delhi",
"subSubLocality": "",
"subLocality": "",
"locality": "Connaught Place",
"city": "New Delhi",
"subDistrict": "Connaught Place",
"district": "New Delhi District",
"state": "Delhi",
"poplrName": "Imperial Hotel New Delhi",
"address": "Janpath Lane, Connaught Place, New Delhi, Delhi, 110001",
"category": "HOTPRE",
"brand_code": "0"
}
]
}
For any queries and support, please contact:
Email us at apisupport@mappls.com
Support
Need support? contact us!