Table of Contents

API —— Löschen von Spatial Map-Karten

Diese Schnittstelle dient dazu, über die mapId die angegebenen Spatial Map-Daten (Raumkarten) permanent zu entfernen.

1. Grundlegende Informationen zur Schnittstelle

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

2. Authentifizierungsmethode

Diese Schnittstelle unterstützt zwei Authentifizierungsmodi:

  1. Token-basierte Authentifizierung:
    • Header: Authorization: [token]
    • Parameter: Erfordert die Angabe von appId.
  2. Signaturbasierte Authentifizierung:
    • Parameter: Erfordert die Angabe von appId, apiKey, timestamp und signature.
    • Detaillierte Berechnungsmethode für die Signatur, siehe API Key signaturmethode.

3. Anfrageparameter

3.1 Pfadparameter (Path Parameters)

Parametername Typ Erforderlich Beschreibung
mapId String Ja Der eindeutige Identifikator (MapId) der Raumkarte.

4. Antwortdatenstruktur (ARMapDTO)

Bei erfolgreicher Anfrage (statusCode 0) enthält das Ergebnis result eine Momentaufnahme der gelöschten Karte.

Feldname Typ Beschreibung
mapId String Eindeutiger Kartenschlüssel.
name String Name der Karte.
status String Aktueller Status der Karte.
size Integer (int64) Dateigröße der Karte.
meta String Benutzerdefinierte Metadaten.
previewUrl String Download-Link für die Vorschau.
emeUrl String Link zur EME-Ressource.
md5 String MD5-Prüfsumme der Datei.
created DateTime Erstellungszeitpunkt.
modified DateTime Zeitpunkt der letzten Änderung.

5. Statuscodes

HTTP-Code Bedeutung Erklärung
200 OK Anfrage erfolgreich, gibt das gelöschte Kartenobjekt zurück.
401 Unauthorized Authentifizierung fehlgeschlagen. Token oder Signatur prüfen.
403 Forbidden Keine Berechtigung zur Ressource.

Statuscode fehlercodes

6. Beispielantwort (JSON)

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