Map details API

This API endpoint retrieves comprehensive details of a VPS map by providing its unique map code in the URL path along with a bearer token for authentication, returning complete information including the map's status, geographic location, spatial metrics (floor areas, elevations, capture points), storage usage, etc.

Get a VPS map by code

get

Retrieves detailed information about a specific VPS map using its unique map code. Returns comprehensive map data including status, coordinates, spatial metrics, and offline bundle information.

Authorizations

bearerAuth

AuthorizationstringRequired

Standard Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path parameters

mapCodestringRequired

Unique map code identifier for the VPS map

Example: MAP_O21DBI05E997Pattern: ^MAP_[A-Z0-9]+$

Responses

200

VPS map retrieved successfully

application/json

400

Bad request - Invalid map code format

application/json

401

Unauthorized - Missing or invalid token

application/json

404

Map not found - The specified map code does not exist

application/json

500

Internal server error

application/json

get

/vps/map/{mapCode}

HTTPcURLJavaScriptPython

GET /v1/vps/map/{mapCode} HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "66ca3f3b773b18f09e131279",
  "accountId": "66ca3f3b773b18f09e131278",
  "mapName": "Office Floor 1 Map",
  "mapCode": "MAP_O21DBI05E997",
  "status": "active",
  "location": {
    "type": "Point",
    "coordinates": [
      -122.4194,
      37.7749,
      50
    ]
  },
  "heading": 45,
  "storage": 52428800,
  "thumbnail": "https://s3.amazonaws.com/bucket/thumbnails/map-thumbnail.jpg",
  "offlineBundleStatus": "active",
  "offlineBundle": "https://s3.amazonaws.com/bucket/bundles/offline-bundle.zip",
  "spatialMetrics": {
    "total_area_sqm": 281.07,
    "num_floors": 2,
    "floors": [
      {
        "floor_id": 0,
        "elevation": 0.15,
        "area_sqm": 142.35,
        "num_captures": 68,
        "bounds": {
          "min": [
            -2.34,
            -5.67
          ],
          "max": [
            15.23,
            12.89
          ]
        }
      },
      {
        "floor_id": 1,
        "elevation": 3.5,
        "area_sqm": 138.72,
        "num_captures": 64,
        "bounds": {
          "min": [
            -2.1,
            -5.45
          ],
          "max": [
            15.1,
            12.67
          ]
        }
      }
    ]
  },
  "createdAt": "2024-08-24T10:30:00.000Z",
  "updatedAt": "2024-08-24T15:45:00.000Z"
}