Table of Contents

API —— search Spatial Map maps

This API is used to search for Spatial Map (spatial maps). All search parameters are optional. When multiple fields are used for searching, the system connects conditions using "AND" logic.

1. Interface basic information

  • Endpoint: https://armap-api-<cn1,na1>.easyar.com/map
  • HTTP method: GET
  • Response format: */* (typically application/json)

2. Authentication methods

This API supports two authentication modes:

  1. Token-based authentication:
    • Header: Authorization: [token]
    • Parameter: Requires AppId.
  2. Signature-based authentication:
    • Uses APIKey, APISecret, AppId and parameters to generate signatures for verification.
    • For detailed signature calculation algorithms, refer to API Key signature method.

3. Request parameters

3.1 Query parameters

All search parameters are optional.

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

4. Response data structure (ARMapDTO)

When the request is successful (statusCode is 0), the result field will contain an array of matching map objects.

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

ARMapDTO object structure

Field Type Description
mapId String Unique identifier of the map.
name String Map name.
status String Current status of the map.
size Integer (int64) Map file size.
gps String Associated GPS coordinate information.
tag String Map tags.
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 token or signature.
403 Forbidden No permission to access the 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"
    }
  ]
}