Table of Contents

API —— Aggiornamento informazioni mappa Spatial Map

Questa interfaccia aggiorna le informazioni della mappa tramite l'mapId specificato. Supporta un aggiornamento di tipo HTTP PATCH, ovvero modifica solo i parametri forniti nella richiesta, mantenendo invariati quelli non forniti.

1. Informazioni di base dell'interfaccia

  • Indirizzo interfaccia: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Metodo richiesta: PUT
  • Formato richiesta: multipart/form-data
  • Formato risposta: */* (solitamente application/json)

2. Metodo di autenticazione

Questa interfaccia supporta due modalità di autenticazione:

  1. Autenticazione basata su Token:
    • Header: Authorization: [token]
    • Parametri: Richiede AppId.
  2. Autenticazione basata su Firma (Signature):
    • Utilizza APIKey, APISecret, AppId e parametri per generare una firma di verifica.
    • Per l'algoritmo dettagliato di calcolo della firma, consultare Metodo di firma API Key.

3. Parametri della richiesta

3.1 Parametri del percorso (Path Parameters)

Nome parametro Tipo Obbligatorio Descrizione
mapId String Identificatore univoco della mappa spaziale (MapId).

3.2 Parametri del modulo (Form Parameters)

Poiché viene utilizzato il formato multipart/form-data, i seguenti parametri devono essere inviati tramite campi del modulo.

Nome parametro Tipo Obbligatorio Descrizione
file File No Nuovo file di dati della mappa.
name String No Nome visualizzato della mappa.
gps String No Coordinate GPS associate alla mappa (es. "121.4541,31.2221").
tag String No Etichetta della mappa.
meta String No Metadati personalizzati (solitamente stringa codificata Base64).
clusterInfo String No Informazioni relative al cluster.
emeBlocklist String No Configurazione lista nera EME, predefinita "[]".

4. Struttura dati della risposta (ARMapDTO)

Quando la richiesta ha successo (statusCode 0), il risultato result conterrà i dettagli dell'oggetto mappa aggiornato.

Nome campo Tipo Descrizione
statusCode Integer Codice di stato. 0 indica successo.
msg String Messaggio descrittivo dello stato.
timestamp DateTime Timestamp di risposta del server.
result Object Oggetto ARMapDTO aggiornato.

Struttura oggetto ARMapDTO

Nome campo Tipo Descrizione
mapId String Identificatore univoco mappa.
name String Nome mappa.
status String Stato corrente mappa.
size Integer (int64) Dimensione file mappa (byte).
gps String Informazioni coordinate GPS associate.
tag String Etichetta mappa.
meta String Metadati personalizzati.
md5 String Codice MD5 di verifica file mappa aggiornato.
modified DateTime Ultima modifica.

5. Codici di stato (Status Codes)

Codice HTTP Significato Descrizione
200 OK Richiesta riuscita.
201 Created Aggiornamento riuscito e record creati.
401 Unauthorized Autenticazione fallita, verificare token o firma.
403 Forbidden Accesso alla risorsa non autorizzato.
404 Not Found mapId specificato non trovato.

Codici di errore Status Code

6. Esempio risposta (JSON)

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