Pins

Pin management

List all pins

get

Query parameters

zoneIdintegerOptional

Responses

200

List of pins

application/json

500

Internal server error

application/json

get

/pins

HTTPcURLJavaScriptPython

GET /api/pins HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "title": "text",
    "latitude": 1,
    "longitude": 1,
    "geoPose": {},
    "contentType": "APK",
    "contentUrl": "text",
    "localizationData": {
      "trackingMode": "WORLD",
      "worldmapURL": "https://example.com"
    },
    "zoneId": 1,
    "gcpId": 1,
    "createdAt": "2025-12-25T12:49:05.023Z",
    "updatedAt": "2025-12-25T12:49:05.023Z"
  }
]

Create a global pin (outside any zone)

post

Creates a pin that is not associated with any specific zone. This allows pinning objects anywhere on the map without being restricted to defined zones.

Body

application/json

titlestringRequired

Title of the pin

contentUrlstring · uriRequired

URL of the content associated with the pin

contentTypestring · enumRequired

Type of content associated with the pin

Possible values:

latitudenumber | nullableOptional

Latitude coordinate (optional, can be derived from geoPose)

longitudenumber | nullableOptional

Longitude coordinate (optional, can be derived from geoPose)

Responses

201

Global pin created successfully

application/json

400

Invalid pin data

application/json

500

Failed to create pin

application/json

post

/pins

HTTPcURLJavaScriptPython

POST /api/pins HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "title": "text",
  "contentUrl": "https://example.com",
  "contentType": "IMAGE",
  "geoPose": {
    "position": {
      "lat": 1,
      "lon": 1,
      "h": 0
    },
    "angles": {
      "yaw": 0,
      "pitch": 0,
      "roll": 0
    }
  },
  "latitude": 1,
  "longitude": 1
}

{
  "id": 1,
  "title": "text",
  "latitude": 1,
  "longitude": 1,
  "geoPose": {},
  "contentType": "APK",
  "contentUrl": "text",
  "localizationData": {
    "trackingMode": "WORLD",
    "worldmapURL": "https://example.com"
  },
  "zoneId": 1,
  "gcpId": 1,
  "createdAt": "2025-12-25T12:49:05.023Z",
  "updatedAt": "2025-12-25T12:49:05.023Z"
}

Delete a global pin

delete

Deletes a global pin by ID and removes any associated uploaded files. This operation cascades to clean up related file records.

Query parameters

idstringRequired

The ID of the pin to delete

Responses

200

Pin deleted successfully

application/json

400

Invalid pin ID or validation failed

application/json

404

Pin not found

application/json

500

Failed to delete pin

application/json

delete

/pins

HTTPcURLJavaScriptPython

DELETE /api/pins?id=text HTTP/1.1
Host: 
Accept: */*

{
  "message": "Pin deleted successfully",
  "deletedPinId": 1,
  "deletedFilesCount": 1
}

Update a pin

put

Path parameters

idintegerRequired

Body

application/json

titlestringRequired

contentUrlstring · uriRequired

contentTypestring · enumRequiredPossible values:

gcpDatastring | nullableOptional

Responses

200

Pin updated

application/json

400

Bad request

application/json

500

Internal server error

application/json

put

/pins/{id}

HTTPcURLJavaScriptPython

PUT /api/pins/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "title": "text",
  "contentUrl": "https://example.com",
  "contentType": "IMAGE",
  "gcpData": "text"
}

{
  "id": 1,
  "title": "text",
  "latitude": 1,
  "longitude": 1,
  "geoPose": {},
  "contentType": "APK",
  "contentUrl": "text",
  "localizationData": {
    "trackingMode": "WORLD",
    "worldmapURL": "https://example.com"
  },
  "zoneId": 1,
  "gcpId": 1,
  "createdAt": "2025-12-25T12:49:05.023Z",
  "updatedAt": "2025-12-25T12:49:05.023Z"
}

Delete a pin

delete

Path parameters

idintegerRequired

Responses

204

Pin deleted

400

Bad request

application/json

404

Resource not found

application/json

500

Internal server error

application/json

delete

/pins/{id}

HTTPcURLJavaScriptPython

DELETE /api/pins/{id} HTTP/1.1
Host: 
Accept: */*

No content