Table of Contents

API - Search Spatial Maps

This interface is used to search Spatial Maps. All search parameters are optional. When multiple fields are used for searching, the system connects the conditions with "AND" logic.

1. Basic interface information

  • Interface address: https://armap-api-<cn1,na1>.easyar.com/map
  • Request method: GET
  • Response format: */* (usually application/json)

2. Authentication method

This interface supports the following two authentication modes:

  1. Token-based authentication:
    • Header: Authorization: [token]
    • Parameter: AppId must be included.
  2. Signature-based authentication:
    • Use APIKey, APISecret, AppId, and parameters to generate a signature for verification.
    • For the detailed signature calculation algorithm, refer to API Key signature method.

3. Request parameters

3.1 Query parameters

All search parameters are optional.

Parameter name Type Required Default value Description
gps String No - Search maps near this GPS coordinate.
range Number No 1.0 Search range (unit: km). Must be used together with the gps parameter.
name String No - Search by map name.
tag String No - Search by map tag.

4. Response data structure (ARMapDTO)

When the request succeeds (statusCode is 0), the returned result contains an array of map objects that meet the conditions.

Field name Type Description
statusCode Integer Status code. 0 indicates success.
msg String Status description information.
timestamp DateTime Server response timestamp.
result Array Array containing ARMapDTO objects.

ARMapDTO object structure

Field name Type Description
mapId String Unique map identifier.
name String Map name.
status String Current status of the map.
size Integer (int64) Map file size.
gps String GPS coordinate information associated with the map.
tag String Map tag.
meta String Custom metadata.
created DateTime Creation time.
modified DateTime Last modification time.

5. Status codes

Http Code Meaning Description
200 OK Request succeeded.
401 Unauthorized Authentication failed. Check the Token or signature.
403 Forbidden No permission to access this resource.

Status Code error codes

6. Example response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": [
    {
      "mapId": "e61db301-e80f-4025-b822-9a00eb48d8d2",
      "name": "office_scene",
      "status": "active",
      "gps": "121.4541,31.2221",
      "tag": "indoor"
    }
  ]
}