Custom Search - Fetch Record Details API¶

Introduction¶

This API allows one to search the nearby records as per specified record types from the Custom search database around the provided reference location. The custom Nearby Search allows organizations and companies to search the locations based records and entities added as per their custom modules.

URL¶

https://search.mappls.com/search/byod/search/{recordId}

Input Method¶

GET

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 the access_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".

Response Type¶

application/json

Response Codes¶

Success¶

200: To denote a successful API call.
204: To denote the API was a success but no results we’re 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.
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 downtimes.

Response Messages¶

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: Forbidden, Services for this key has been suspended due to daily/hourly transactions limit.
500: Something went wrong.
503: Maintenance Break.

Request Parameters¶

Mandatory Parameters¶

recordId (string) : A path parameter that indicates the unique identifier of the record from client.

Sample cURL Request¶

curl --location 'https://search.mappls.com/search/byod/search/1001?access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm'

Sample Response¶

{
    "records": [
        {
            "recordId": "1001",
            "recordEloc": null,
            "recordType": "WFHORWFO",
            "distance": 0,
            "orderIndex": 1,
            "latitude": 28.50833,
            "longitude": 77.33518,
            "customNote": "",
            "createdOn": 1637841635,
            "modifiedOn": 1637841635,
            "isExpired": false,
            "extendedInfo": {
                "address": "237 okhla",
                "id type": "mobile number",
                "organization": "CE Infosystems",
                "WFH": "N",
                "location": "Home",
                "team": "API Support"
            }
        }
    ]
}

For any queries and support, please contact:

Email us at apisupport@mappls.com

Support Need support? contact us!