Get details for an individual asset

GET /asset-indoor-positions/{assetId}

Path parameters

assetId string Required

ID of the asset

Responses

200 application/json

Details of an asset's indoor position
Hide response attributes Show response attributes object
- position object Required
  
  Additional properties are NOT allowed.
  
  Hide position attributes Show position attributes object
  
  x number Required
  
  X coordinate
  
  y number Required
  
  Y coordinate
  
  z number
  
  Z coordinate
  
  accuracyRadius number
  
  Accuracy of the position as a radius
  
  stationaryConfidence number
  
  Percentage confidence the asset is stationary
  
  locatedAt string(date-time) Required
  
  beaconMac string
  
  The mac address of the beacon
  
  networkId string
  
  The ID of the network the position was detected on
- asset object Required
  
  Additional properties are NOT allowed.
  
  Hide asset attributes Show asset attributes object
  
  id string Required
  
  The system ID of an asset
  
  name string
  
  The given name for an asset
- inZones array[object]
  
  Hide inZones attributes Show inZones attributes object
  
  enteredAt string(date-time) Required
  
  zone object Required
  
  Additional properties are NOT allowed.
  
  Hide zone attributes Show zone attributes object
  
  id string Required
  
  System ID for a zone
  
  externalId string
  
  External systems ID for a zone
  
  name string
  
  Displayable name for a zone
  
  levelName string
  
  Name of a vertical level within a zone
400 application/json

Invalid request
Hide response attributes Show response attributes object
- statusCode string Required
  
  HTTP status code of the error, e.g. 400, 404
- id string Required
  
  A unique identifier for this particular occurrence of the problem
- timestamp string(date-time)
  
  Timestamp of the error in ISO 8601 format
- title string
  
  A short, human-readable summary of the problem
- detail string
  
  A human-readable explanation specific to this occurrence of the problem
- method string
  
  The HTTP method of the request that caused the error
- path string
  
  The path of the request that caused the error
- query object
  
  The query parameters of the request that caused the error
  
  Additional properties are allowed.
- body object
  
  The body of the request that caused the error
  
  Additional properties are allowed.
401 application/json

API key not supplied
Hide response attributes Show response attributes object
- statusCode string Required
  
  HTTP status code of the error, e.g. 400, 404
- id string Required
  
  A unique identifier for this particular occurrence of the problem
- timestamp string(date-time)
  
  Timestamp of the error in ISO 8601 format
- title string
  
  A short, human-readable summary of the problem
- detail string
  
  A human-readable explanation specific to this occurrence of the problem
- method string
  
  The HTTP method of the request that caused the error
- path string
  
  The path of the request that caused the error
- query object
  
  The query parameters of the request that caused the error
  
  Additional properties are allowed.
- body object
  
  The body of the request that caused the error
  
  Additional properties are allowed.
403 application/json

Invalid API key or permissions
Hide response attributes Show response attributes object
- statusCode string Required
  
  HTTP status code of the error, e.g. 400, 404
- id string Required
  
  A unique identifier for this particular occurrence of the problem
- timestamp string(date-time)
  
  Timestamp of the error in ISO 8601 format
- title string
  
  A short, human-readable summary of the problem
- detail string
  
  A human-readable explanation specific to this occurrence of the problem
- method string
  
  The HTTP method of the request that caused the error
- path string
  
  The path of the request that caused the error
- query object
  
  The query parameters of the request that caused the error
  
  Additional properties are allowed.
- body object
  
  The body of the request that caused the error
  
  Additional properties are allowed.
404 application/json

Item not found
Hide response attributes Show response attributes object
- statusCode string Required
  
  HTTP status code of the error, e.g. 400, 404
- id string Required
  
  A unique identifier for this particular occurrence of the problem
- timestamp string(date-time)
  
  Timestamp of the error in ISO 8601 format
- title string
  
  A short, human-readable summary of the problem
- detail string
  
  A human-readable explanation specific to this occurrence of the problem
- method string
  
  The HTTP method of the request that caused the error
- path string
  
  The path of the request that caused the error
- query object
  
  The query parameters of the request that caused the error
  
  Additional properties are allowed.
- body object
  
  The body of the request that caused the error
  
  Additional properties are allowed.
default application/json

General error
Hide response attributes Show response attributes object
- statusCode string Required
  
  HTTP status code of the error, e.g. 400, 404
- id string Required
  
  A unique identifier for this particular occurrence of the problem
- timestamp string(date-time)
  
  Timestamp of the error in ISO 8601 format
- title string
  
  A short, human-readable summary of the problem
- detail string
  
  A human-readable explanation specific to this occurrence of the problem
- method string
  
  The HTTP method of the request that caused the error
- path string
  
  The path of the request that caused the error
- query object
  
  The query parameters of the request that caused the error
  
  Additional properties are allowed.
- body object
  
  The body of the request that caused the error
  
  Additional properties are allowed.

GET /asset-indoor-positions/{assetId}

curl \
 --request GET 'http://{host}/api/v1/asset-indoor-positions/{assetId}' \
 --header "x-api-key: $API_KEY"

Response examples (200)

{
  "position": {
    "x": 42.0,
    "y": 42.0,
    "z": 42.0,
    "accuracyRadius": 42.0,
    "stationaryConfidence": 42.0,
    "locatedAt": "2025-05-04T09:42:00Z",
    "beaconMac": "string",
    "networkId": "string"
  },
  "asset": {
    "id": "string",
    "name": "string"
  },
  "inZones": [
    {
      "enteredAt": "2025-05-04T09:42:00Z",
      "zone": {
        "id": "string",
        "externalId": "string",
        "name": "string",
        "levelName": "string"
      }
    }
  ]
}

Response examples (400)

{
  "statusCode": "string",
  "id": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "title": "string",
  "detail": "string",
  "method": "string",
  "path": "string",
  "query": {},
  "body": {}
}

Response examples (401)

{
  "statusCode": "string",
  "id": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "title": "string",
  "detail": "string",
  "method": "string",
  "path": "string",
  "query": {},
  "body": {}
}

Response examples (403)

{
  "statusCode": "string",
  "id": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "title": "string",
  "detail": "string",
  "method": "string",
  "path": "string",
  "query": {},
  "body": {}
}

Response examples (404)

{
  "statusCode": "string",
  "id": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "title": "string",
  "detail": "string",
  "method": "string",
  "path": "string",
  "query": {},
  "body": {}
}

Response examples (default)

{
  "statusCode": "string",
  "id": "string",
  "timestamp": "2025-05-04T09:42:00Z",
  "title": "string",
  "detail": "string",
  "method": "string",
  "path": "string",
  "query": {},
  "body": {}
}