Table of Contents

API: Get Spatial Map list

This API is used to page through and obtain list information for all Spatial Maps under the current image library.

1. Basic API information

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

2. Authentication

This API 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, see API Key signature method.

3. Request parameters

3.1 Query parameters (Query Parameters)

Pagination parameters are optional. If they are not filled in, default values are used.

Parameter name Type Required Default Description
pageNum Integer No 1 Requested target page number.
pageSize Integer No 10 Maximum number of maps displayed per page.

4. Response data structure (ResponseResult)

When the request succeeds (statusCode is 0), the returned result contains the map list and its pagination metadata.

Field name Type Description
statusCode Integer Status code. 0 indicates success.
msg String Status description.
timestamp DateTime Server response timestamp.
result Object Map object containing the map data array and pagination statistics.

5. Status codes

Http Code Meaning Notes
200 OK Request succeeded.
401 Unauthorized Authentication failed. Check the Token or signature.
403 Forbidden No permission to access this resource.
404 Not Found Related resource was not found.

Status Code error codes

6. Example response (JSON)

{
  "result": {
    "armaps": [
      {
        "mapId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "gps": "[0.0, 0.0]",
        "name": "Map_2020-09-28_1302",
        "size": 124140,
        "status": "active",
        "auxiliaryId": "62d4f765-cc54-4dff-9c48-b7c8b4adbde9",
        "created": 1601245841687,
        "modified": 1601245841687,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...",
        "appKey": "C:NA1:6fc8fe27af4a4d6cb02f4b494d2a9f.."
      },
      {
        "mapId": "5ccdf1fb-0cd3-4580-80aa-42bd2289...",
        "gps": "[0.0, 0.0]",
        "name": "test",
        "size": 2419184,
        "status": "active",
        "auxiliaryId": "5ccdf1fb-0cd3-4580-80aa-42bd22897b...",
        "floor": "1",
        "tag": "cat",
        "created": 1601244090670,
        "modified": 1601244090670,
        "mapVersion": "esm1",
        "mapUrl": "https://prod-armap-1348728941.cos.na-siliconvalley....",
        "previewUrl": "https://prod-armap-1348728941.cos.na-siliconvalley...."
      }
    ],
    "page": {
      "total": 2,
      "pageNum": 1,
      "pageSize": 10,
      "pages": 1
    }
  },
  "statusCode": 0,
  "msg": "Success",
  "timestamp": 1769406021019
}