Robot

Update robot details

Update hardware details of robot.

POST/api/robot/updateDetails

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-schemeenum<string>headerrequireddefault: api-token

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json · object

Request to update robot details.

descriptionstring | nullbody

Optional description for the robot

Example: "Patrols the lobby."

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

latitudenumber<double> | nullbody

Optional latitude coordinate

Example: 37.7749

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | nullbody

Optional longitude coordinate

Example: -122.4194

namestring | nullbody

Optional name for the robot

Example: "Robocop"

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdatedboolean | nullbody

Whether the sub-locations hierarchy key has been updated

Example: false

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/robot/updateDetails' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Patrols the lobby.",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "latitude": 37.7749,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "longitude": -122.4194,
    "name": "Robocop",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": false
  }'

import requests

url = "https://api2.rhombussystems.com/api/robot/updateDetails"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "description": "Patrols the lobby.",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "latitude": 37.7749,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "longitude": -122.4194,
    "name": "Robocop",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": False
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/robot/updateDetails', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "description": "Patrols the lobby.",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "latitude": 37.7749,
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "longitude": -122.4194,
    "name": "Robocop",
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "subLocationsHierarchyKeyUpdated": false
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "description": "Patrols the lobby.",
              "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "latitude": 37.7749,
              "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "longitude": -122.4194,
              "name": "Robocop",
              "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
              "subLocationsHierarchyKeyUpdated": false
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/robot/updateDetails"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null