Table of Contents

API: Memperbarui informasi Spatial Map

API ini memperbarui informasi peta melalui mapId yang ditentukan. API ini mendukung metode pembaruan mirip HTTP PATCH, yaitu hanya parameter yang diberikan dalam request yang diubah, sedangkan parameter yang tidak diberikan tetap sama.

1. Informasi dasar API

  • Alamat API: https://armap-api-<cn1,na1>.easyar.com/map/{mapId}
  • Metode request: PUT
  • Format request: multipart/form-data
  • Format respons: */* (biasanya application/json)

2. Autentikasi

API ini mendukung dua mode autentikasi berikut:

  1. Autentikasi berbasis Token:
    • Header: Authorization: [token]
    • Parameter: AppId harus disertakan.
  2. Autentikasi berbasis Signature:
    • Gunakan APIKey, APISecret, AppId, dan parameter untuk membuat signature guna verifikasi.
    • Untuk algoritme detail perhitungan signature, lihat metode signature API Key.

3. Parameter request

3.1 Parameter path (Path Parameters)

Nama parameter Tipe Wajib Deskripsi
mapId String Ya Pengidentifikasi unik Spatial Map (MapId).

3.2 Parameter formulir (Form Parameters)

Karena menggunakan format multipart/form-data, parameter berikut harus dikirim sebagai field formulir.

Nama parameter Tipe Wajib Deskripsi
file File Tidak File data peta baru.
name String Tidak Nama tampilan peta.
gps String Tidak Koordinat GPS yang terkait dengan peta, misalnya "121.4541,31.2221".
tag String Tidak Tag peta.
meta String Tidak Metadata kustom, biasanya string yang dienkode Base64.
clusterInfo String Tidak Informasi terkait cluster.
emeBlocklist String Tidak Konfigurasi blocklist EME. Default-nya "[]".

4. Struktur data respons (ARMapDTO)

Ketika request berhasil (statusCode bernilai 0), result yang dikembalikan berisi detail objek peta yang telah diperbarui.

Nama field Tipe Deskripsi
statusCode Integer Kode status. 0 berarti berhasil.
msg String Informasi deskripsi status.
timestamp DateTime Timestamp respons server.
result Object Objek ARMapDTO yang telah diperbarui.

Struktur objek ARMapDTO

Nama field Tipe Deskripsi
mapId String Pengidentifikasi unik peta.
name String Nama peta.
status String Status peta saat ini.
size Integer (int64) Ukuran file peta dalam byte.
gps String Informasi koordinat GPS yang terkait dengan peta.
tag String Tag peta.
meta String Metadata kustom.
md5 String Checksum MD5 file peta setelah pembaruan.
modified DateTime Waktu modifikasi terakhir.

5. Kode status

Http Code Arti Keterangan
200 OK Request berhasil.
201 Created Pembaruan berhasil dan record terkait telah dibuat.
401 Unauthorized Autentikasi gagal. Periksa Token atau signature.
403 Forbidden Tidak berhak mengakses resource ini.
404 Not Found mapId yang ditentukan tidak ditemukan.

Kode error Status Code

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