Table of Contents

API —— Aktualisieren von Spatial Map-Karteninformationen

Diese Schnittstelle aktualisiert Karteninformationen über die angegebene mapId. Sie unterstützt ein HTTP PATCH-ähnliches Update-Verhalten, d.h. nur die im Anfragebody angegebenen Parameter werden geändert, nicht angegebene Parameter bleiben unverändert.

1. Grundlegende Schnittstelleninformationen

  • Schnittstellenadresse: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Anfragemethode: PUT
  • Anfrageformat: multipart/form-data
  • Antwortformat: */* (typischerweise application/json)

2. Authentifizierungsmethoden

Diese Schnittstelle unterstützt die folgenden zwei Authentifizierungsmodi:

  1. Token-basierte Authentifizierung:
    • Header: Authorization: [token]
    • Parameter: Erfordert AppId.
  2. Signatur-basierte (Signature) Authentifizierung:
    • Verwendet APIKey, APISecret, AppId und Parameter zur Signaturgenerierung und -prüfung.
    • Detaillierte Algorithmen zur Signaturberechnung finden Sie unter API Key-Signaturmethode.

3. Anfrageparameter

3.1 Pfadparameter (Path Parameters)

Parametername Typ Erforderlich Beschreibung
mapId String Ja Eindeutiger Bezeichner (MapId) der Spatial Map.

3.2 Formularparameter (Form Parameters)

Aufgrund des multipart/form-data-Formats müssen die folgenden Parameter als Formularfelder übermittelt werden.

Parametername Typ Erforderlich Beschreibung
file File Nein Neue Kartendatendatei.
name String Nein Anzeigename der Karte.
gps String Nein Der Karte zugeordnete GPS-Koordinaten (z.B.: "121.4541,31.2221").
tag String Nein Karten-Tag.
meta String Nein Benutzerdefinierte Metadaten (typischerweise ein Base64-kodierter String).
clusterInfo String Nein Cluster-bezogene Informationen.
emeBlocklist String Nein EME-Sperrliste-Konfiguration, standardmäßig "[]".

4. Antwortdatenstruktur (ARMapDTO)

Wenn die Anfrage erfolgreich ist (statusCode ist 0), enthält das Ergebnis result Details des aktualisierten Kartenobjekts.

Feldname Typ Beschreibung
statusCode Integer Statuscode. 0 bedeutet Erfolg.
msg String Statusbeschreibung.
timestamp DateTime Zeitstempel der Serverantwort.
result Object Aktualisiertes ARMapDTO-Objekt.

ARMapDTO-Objektstruktur

Feldname Typ Beschreibung
mapId String Eindeutiger Kartenbezeichner.
name String Kartenname.
status String Aktueller Kartenstatus.
size Integer (int64) Kartendateigröße in Bytes.
gps String Der Karte zugeordnete GPS-Koordinateninformationen.
tag String Karten-Tag.
meta String Benutzerdefinierte Metadaten.
md5 String MD5-Prüfsumme der aktualisierten Kartendatei.
modified DateTime Zeitpunkt der letzten Änderung.

5. Statuscodes (Status Codes)

HTTP-Code Bedeutung Erklärung
200 OK Anfrage erfolgreich.
201 Created Update erfolgreich und zugehörige Datensätze wurden erstellt.
401 Unauthorized Authentifizierung fehlgeschlagen. Bitte Token oder Signatur prüfen.
403 Forbidden Keine Berechtigung zum Zugriff auf diese Ressource.
404 Not Found Angegebene mapId nicht gefunden.

Status Code-Fehlercodes

6. Beispielantwort (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"
  }
}