Retrieve a secure stream URL for indoor positions

POST /asset-indoor-positions-stream

Api key

application/json

Body

Filter to be applied to the indoor location stream

filter object

Additional properties are NOT allowed.
Hide filter attributes Show filter attributes object
- assetIds array[string]
  
  Asset IDs to restrict the websocket by
  
  At least 1 element.
- assetNames array[string]
  
  Asset names to restrict the websocket by
  
  At least 1 element.

Responses

200 application/json

Details of the websocket stream
Hide response attribute Show response attribute object
- websocketUrl string Required
  
  Websocket URl to recieve the event stream
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.
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.

POST /asset-indoor-positions-stream

curl \
 --request POST 'http://{host}/api/v1/asset-indoor-positions-stream' \
 --header "x-api-key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"filter":{"assetIds":["string"],"assetNames":["string"]}}'

Request examples

{
  "filter": {
    "assetIds": [
      "string"
    ],
    "assetNames": [
      "string"
    ]
  }
}

Response examples (200)

{
  "websocketUrl": "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 (default)

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