Table of Contents

API - Удаление Spatial Map

Этот API используется для постоянного удаления указанных данных Spatial Map по mapId.

1. Основная информация API

  • API endpoint: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Метод request: DELETE
  • Формат response: */* (обычно application/json)

2. Authentication

Этот API поддерживает следующие два режима authentication:

  1. Authentication на основе Token:
    • Header: Authorization: [token]
    • Параметр: необходимо указать appId.
  2. Authentication на основе Signature:
    • Параметры: необходимо указать appId, apiKey, timestamp и signature.
    • Подробный алгоритм расчета signature см. в методе signature API Key.

3. Параметры request

3.1 Path parameters

Имя параметра Тип Обязательный Описание
mapId String Да Уникальный идентификатор spatial map (MapId).

4. Структура данных response (ARMapDTO)

Когда request успешен (statusCode равен 0), возвращаемый result содержит snapshot information удаленной map.

Имя поля Тип Описание
mapId String Уникальный идентификатор map.
name String Имя map.
status String Текущий статус map.
size Integer (int64) Размер файла map.
meta String Пользовательские metadata.
previewUrl String Ссылка для загрузки preview image.
emeUrl String Ссылка на EME resource.
md5 String MD5 checksum файла.
created DateTime Время создания.
modified DateTime Время последнего изменения.

5. Status codes

Http Code Значение Описание
200 OK Request успешен, возвращает удаленный объект map.
401 Unauthorized Authentication failed. Проверьте Token или signature.
403 Forbidden Нет прав доступа к этому resource.

Ошибки Status Code

6. Пример response (JSON)

{
  "statusCode": 0,
  "msg": "success",
  "timestamp": "2026-01-30T10:00:00Z",
  "result": {
    "mapId": "string",
    "name": "example_map",
    "status": "inactive",
    "size": 1024
  }
}