Map details

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

_idstringRequired

Unique MongoDB ObjectId for the VPS map

Example: 66ca3f3b773b18f09e131279

accountIdstringRequired

Account ID that owns this VPS map

Example: 66ca3f3b773b18f09e131278

mapNamestringRequired

Human-readable name of the VPS map

Example: Office Floor 1 Map

mapCodestringRequired

Unique code identifier for the VPS map

Example: MAP_O21DBI05E997

statusstring · enumRequired

Current processing status of the map:

• uploading: File upload in progress
• pending: Processing queued or in progress
• active: Map is ready for use
• failed: Processing failed

Example: activePossible values:

headingnumber · max: 360 · nullableOptional

Map heading/orientation in degrees (0-360)

Example: 45

storagenumberRequired

Storage size used by the map in bytes

Example: 52428800

thumbnailstring · uri · nullableOptional

URL to the map thumbnail image

Example: https://s3.amazonaws.com/bucket/thumbnails/map-thumbnail.jpg

offlineBundleStatusstring · enum · nullableOptional

Status of the offline bundle generation:

• processing: Bundle creation in progress
• failed: Bundle creation failed
• active: Bundle is ready for download

Example: activePossible values:

offlineBundlestring · uri · nullableOptional

URL to download the offline bundle for this map

Example: https://s3.amazonaws.com/bucket/bundles/offline-bundle.zip

createdAtstring · date-timeRequired

ISO 8601 timestamp when the map was created

Example: 2024-08-24T10:30:00.000Z

updatedAtstring · date-timeRequired

ISO 8601 timestamp when the map was last updated

Example: 2024-08-24T15:45:00.000Z

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"
}

GET All VPS maps for an account

Get all VPS maps

get

Retrieves a paginated list of VPS maps using limit and page parameters

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · min: 1 · max: 100Optional

Number of items to return per page

Default: 10Example: 10

pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1

Responses

200

VPS maps retrieved successfully

application/json

401

Unauthorized

application/json

get

/vps/map

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "66ca3f3b773b18f09e131279",
      "name": "Office Building Map",
      "description": "3D map of the main office building",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "status": "active"
    }
  ],
  "pagination": {
    "totalItems": 45,
    "totalPages": 5,
    "currentPage": 1,
    "itemsPerPage": 10
  }
}

Get paginated list of MapSets

get

Retrieves a paginated list of MapSets associated with the authenticated user's account

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitinteger · min: 1 · max: 100Optional

Number of items to return per page

Default: 10Example: 10

pageinteger · min: 1Optional

Page number for pagination

Default: 1Example: 1

Responses

200

MapSets retrieved successfully

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized

application/json

500

Internal Server Error - Something went wrong on the server

application/json

get

/vps/map-set

HTTPcURLJavaScriptPython

GET /v1/vps/map-set HTTP/1.1
Host: api.multiset.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "66ca3f3b773b18f09e131280",
      "name": "Office Buildings Collection",
      "description": "Collection of office building maps",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "status": "active",
      "mapCount": 3
    }
  ],
  "pagination": {
    "totalItems": 12,
    "totalPages": 2,
    "currentPage": 1,
    "itemsPerPage": 10
  }
}