Table of Contents

API - Excluir uma Spatial Map

Esta API é usada para excluir permanentemente os dados da Spatial Map especificada por mapId.

1. Informações básicas da API

  • API endpoint: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Método da request: DELETE
  • Formato da response: */* (geralmente application/json)

2. Authentication

Esta API oferece suporte aos dois modos de authentication a seguir:

  1. Authentication baseada em Token:
    • Header: Authorization: [token]
    • Parameter: deve incluir appId.
  2. Authentication baseada em Signature:
    • Parameters: deve incluir appId, apiKey, timestamp e signature.
    • Para o algoritmo detalhado de cálculo da signature, consulte método de signature API Key.

3. Parâmetros da request

3.1 Path parameters

Nome do parâmetro Tipo Obrigatório Descrição
mapId String Sim Identificador único da spatial map (MapId).

4. Estrutura de dados da response (ARMapDTO)

Quando a request é bem-sucedida (statusCode é 0), o result retornado contém snapshot information da map excluída.

Nome do campo Tipo Descrição
mapId String Identificador único da map.
name String Nome da map.
status String Status atual da map.
size Integer (int64) Tamanho do arquivo da map.
meta String Metadata personalizada.
previewUrl String Link para download de preview image.
emeUrl String Link do resource EME.
md5 String MD5 checksum do arquivo.
created DateTime Hora de criação.
modified DateTime Hora da última modificação.

5. Status codes

Http Code Significado Descrição
200 OK request bem-sucedida, retorna o objeto map excluído.
401 Unauthorized authentication falhou, verifique Token ou signature.
403 Forbidden Sem permissão para acessar este resource.

Error codes de Status Code

6. Exemplo de response (JSON)

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