Custom Search - Search Record API¶

Introduction¶

This API allows one to search the records as per specified search criteria from the Custom search database in either nearby search around the provided reference location OR through text search. The custom Search Record API 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?

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 For Nearby Search¶

recordType (string) : The category or class of the record, referenced by a defined set of category codes from client.
refLocation (string) : Provides the location around which the search will be performed. e.g. refLocation=28.454,77.435
- The refLocation parameter can also accept eLoc as reference location. Example: refLocation=17ZUL7

Optional Parameters for Nearby Search¶

radius (integer) : The radius in meters for radial search. Default radius: 10000 meters.
sortBy (string) : Provides configured sorting operations for the client on cloud. Below are the available sorts:
- dist:asc
- dist:desc will sort data in order of distance from the passed location (default is dist:asc).Example : sortBy=dist:asc.

Mandatory Parameters for Text Search¶

query (string): text string that will be searched on attributes specified for textual search within the customer's workspace.

Common Parameters for Search¶

filter (string) : Filter option as per customer defined data representation schema. In addition to customer specified data representation schema, MapmyIndia also offers its own geo-administrative filter criteria powered by MapmyIndia Maps' administrative hierarcy.
- filter=cop{eLoc} (string) : This field accepts eloc of any administrative area and restricts the search to the provided administrative area eloc. Example : filter=cop:TAVI5S.
- filter (string): can also be customer specific as defined in the data registration schema for the project. Types of filters operations are available in the appendix table 2; which are relative to the type of custom data attributes added (as mentioned in appendix table 1). Example: filter=specialities:neurosurgery
createdTime (integer) : This is an epoch value in seconds. The filter acts as follows: All records whose creation time is 'greater than' the provided input time here are responded back in results. Example: createdTime=1628855941
modifiedTime (integer) : This is an epoch value in seconds. The filter acts as follows: All records whose modified time is 'greater than' the provided input time here are responded back in results. Example: modifiedTime=1628855941
itemCount (integer) : Number of items per page. Minimum is 1; Default is 10.
page (integer): provides number of the page to provide results from.
bounds (string) : '(x1,y1;x2,y2) Allows the developer to send in map bounds to provide a nearby search of the geobounds. where x1,y1 are the lat lng of the bound. The bounds are set from topLeft to bottomRight (North-West to South-East). Example : 28.639256,77.211133;28.625214,77.237483.

Sample cURL Request¶

curl --location 'https://search.mappls.com/search/byod/search?access_token=hklmgbwzrxncdyavtsuojqpiefrbhqplnm&recordType=WFHORWFO&page=1&radius=5000&refLocation=28.550492131024388%2C77.26895656485871'

Sample Response¶

{
    "records": [
        {
            "recordId": "1001",
            "recordEloc": null,
            "recordType": "WFHORWFO",
            "distance": 3801,
            "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"
            }
        },
        {
            "recordId": "1002",
            "recordEloc": "06J7HP",
            "recordType": "WFHORWFO",
            "distance": 3806,
            "orderIndex": 2,
            "latitude": null,
            "longitude": null,
            "customNote": "MapmyIndia Head Office",
            "createdOn": 1637843082,
            "modifiedOn": 1637843174,
            "isExpired": false,
            "extendedInfo": {
                "pincode": "110044",
                "address": "237 okhla",
                "id type": "mobile number",
                "organization": "CE Infosystems",
                "WFH": "N",
                "location": "Home",
                "team": "API Support"
            }
        }
    ],
    "pageInfo": {
        "pageCount": 1,
        "totalHits": 2,
        "totalPages": 1,
        "pageSize": 10
    }
}

Appendix Table 1¶

Serial	dataType	Description
1	`text`	Supports textual data.
2	`double`	This datatype allows only fractional numbers.
3	`long`	The data type can store whole numbers from -9223372036854775808 to 9223372036854775807
4	`integer`	The data type can store whole numbers from -2147483648 to 2147483647
5	`boolean`	Support Boolean values true or false

Appendix Table 2¶

Serial	Filter Name	Filter Operation	Supported dateTypes	Description
1	`exact`	:	`text`, `integer`, `long`, `double`, `boolean`	This is used for full text search queries.
2	`range`	-le, -ge, -lt, -gt, -bt	`Integer`, `long`, `double`	Is used with comparison operators
3	`logical`	;(or), $(and)	`text`, `integer`, `long`, `double`, `boolean`	Is used to combine two filter criteria.