UWB API v1

The UWB API provides access to the ultra-wideband (UWB) service.

Authorization

x-api-key<token>

In: header

Path Parameters

projectIdRequirednumber

Response Body

responseRequiredarray<object>

Bad Request

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Unauthorized

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Forbidden

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Internal Server Error

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

curl -X GET "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/tags" \
  -H "x-api-key: <token>"

fetch("https://staging.saharobotik.com/api/v1/client/iot/uwb/0/tags", {
  headers: {
    "x-api-key": "<token>"
  }
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/tags"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("x-api-key", "<token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/tags"

response = requests.request("GET", url, headers = {
  "x-api-key": "<token>"
})

print(response.text)

[
  {
    "id": "string",
    "label": "string",
    "online": true
  }
]

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "resultCode": "string",
  "message": "string",
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

Send a buzzer ping command to tag device

Authorization

x-api-key<token>

In: header

Request Body

application/jsonRequired

labelRequiredstring

Path Parameters

projectIdRequirednumber

Response Body

successRequiredboolean

Bad Request

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Unauthorized

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Forbidden

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

detailsRequiredobject

Details of the error. When the error is a validation error, this will be an array of objects.

Format: "object"

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

Internal Server Error

statusCodeRequirednumber

Error code.

errorRequiredstring

Error.

resultCodestring

Custom error code.

messageRequiredstring

Error message.

requestIdRequiredstring

Unique request id.

timestampRequiredstring

Timestamp of the error.

pathRequiredstring

Path of the request.

curl -X POST "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/buzzer-ping" \
  -H "x-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "string"
  }'

const body = JSON.stringify({
  "label": "string"
})

fetch("https://staging.saharobotik.com/api/v1/client/iot/uwb/0/buzzer-ping", {
  headers: {
    "x-api-key": "<token>"
  },
  body
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/buzzer-ping"
  body := strings.NewReader(`{
    "label": "string"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("x-api-key", "<token>")
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "https://staging.saharobotik.com/api/v1/client/iot/uwb/0/buzzer-ping"
body = {
  "label": "string"
}
response = requests.request("POST", url, json = body, headers = {
  "x-api-key": "<token>",
  "Content-Type": "application/json"
})

print(response.text)

{
  "success": true
}

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 0,
  "error": "string",
  "resultCode": "string",
  "message": "string",
  "details": [
    {
      "property": "foo",
      "constraints": [
        "foo is required"
      ]
    }
  ],
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "resultCode": "string",
  "message": "string",
  "requestId": "string",
  "timestamp": "string",
  "path": "string"
}

Table of Contents