Query parameters

• assetNames array[string]

  List of asset names to filter by, separated by commas

• inZoneIds array[string]

  List of zones IDs to filter assets by, separated by commas

• inZoneNames array[string]

  List of zones names to filter assets by, separated by commas

• limit integer

  Number of items to return

  Minimum value is 1, maximum value is 100. Default value is 10.

• nextToken string

  Pagination token to get next page of items

Responses

• 200 application/json

  List of asset indoor positions

  Hide response attributes Show response attributes object

  • nextToken string

    Token to use to request the next page of results, if available

  • items array[object] Required
    Hide items attributes Show items 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.

• 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.