Skip to content
IoT OS

List a device's location bindings

GET
/integration/v1/organizations/{organization}/devices/{uuid}/location-bindings
curl --request GET \
  --url https://api.elwids.xyz/api/integration/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/location-bindings \
  --header 'Authorization: Bearer <token>'

Requires: telemetry:read

Rate limits: 240 a minute per address, 60 a minute per application

The approved, immutable location-binding.v1 bindings active for a granted device, ordered by creation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organization
required
string format: uuid

The organization UUID. A value that does not match returns 404.

uuid
required
string format: uuid

A value that does not match returns 404.

Query Parameters

Section titled “Query Parameters”
page
integer
>= 1 <= 100000
per_page
integer
>= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

A page of binding versions.

Media typeapplication/json
object
meta
required
object
current_page
required
integer
>= 1
last_page
required
integer
>= 1
total
required
integer
data
required
Array<object>
<= 100 items

An approved, immutable location binding and the version that carries it.

object
version_uuid
required

Pass as version_uuid to read a fix through this binding.

string format: uuid
binding
required
object
schema_version
required
Allowed value: location-binding.v1
uuid
required
string format: uuid
revision
required
integer
>= 1
organization_uuid
required
string format: uuid
device_uuid
required
string format: uuid
configuration_uuid
required
string format: uuid
generation
required
integer
>= 1
latitude_parameter_uuid
required
string format: uuid
longitude_parameter_uuid
required
string format: uuid
accuracy_parameter_uuid
required
Any of:
string format: uuid
pairing
required
Allowed value: same_event
max_age_seconds
required
integer
>= 1 <= 86400
max_future_skew_seconds
required
integer
<= 300
allow_unknown_accuracy
required
boolean

Example 

{
  "data": [
    {
      "version_uuid": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e",
      "binding": {
        "schema_version": "location-binding.v1",
        "uuid": "00000000-0000-4000-8000-000000000001",
        "revision": 1,
        "organization_uuid": "00000000-0000-4000-8000-000000000002",
        "device_uuid": "00000000-0000-4000-8000-000000000003",
        "configuration_uuid": "00000000-0000-4000-8000-000000000004",
        "generation": 1,
        "latitude_parameter_uuid": "00000000-0000-4000-8000-000000000005",
        "longitude_parameter_uuid": "00000000-0000-4000-8000-000000000006",
        "accuracy_parameter_uuid": "00000000-0000-4000-8000-000000000007",
        "pairing": "same_event",
        "max_age_seconds": 90,
        "max_future_skew_seconds": 5,
        "allow_unknown_accuracy": true
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "total": 1
  }
}

Headers

Section titled “Headers”
Cache-Control
required
string
/(^|[ ,])no-store([ ,]|$)/

Responses to authenticated integration requests are never cached. The header also carries private.

Example 
no-store, private

401

Section titled “401”

No valid credentials: no session (first-party API), or a missing, invalid, expired or revoked application token (integration API).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

403

Section titled “403”

The caller is not allowed: not a member of the organization, missing a tenant or platform permission, or (integration API) an ability not granted on both the application and the token.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

404

Section titled “404”

Not found: an unknown organization or resource, a resource in another organization or not granted to the application, or a malformed identifier (the route does not match).

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

422

Section titled “422”

The input failed validation.

Media typeapplication/json

422 for input that failed validation.

object
message
required

The first error, followed by a count of the others.

string
errors
required

Messages per field, keyed by the field’s dotted path. A rejection by the device runtime appears under runtime.

object
runtime
Array<string>
key
additional properties
Array<string>

Example generated

{
  "message": "example",
  "errors": {
    "runtime": [
      "example"
    ]
  }
}

429

Section titled “429”

A rate limit was reached; see x-rate-limits on the operation.

Media typeapplication/json

The body of most error responses.

object
message
required
string

Example generated

{
  "message": "example"
}

Headers

Section titled “Headers”
Retry-After
required
integer

Seconds to wait before retrying.

Report a problem with this page