Get schedule data V2

Get weekly schedules in org with usage data

POST /api/schedule/getScheduleDataV2

Get schedule data V2

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/schedule/getScheduleDataV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>",
  "weeklyScheduleData": {
    "accessGrantUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "alarmMonitoringUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "alertPolicyUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "customEventUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "doorSettingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "intervalList": [
      {
        "minuteOfWeekStart": 123,
        "minuteOfWeekStop": 123
      }
    ],
    "locationsUsedIn": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "mutable": true,
    "name": "<string>",
    "oneTimeUse": true,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ruleUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "sharedStreamUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Authorizations

x-auth-apikey · string · header · required

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-scheme · enum<string> · default: api-token · required

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

Request object for getting schedule data v2.

scheduleUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for getting schedule data v2.

error · boolean | null

errorMsg · string | null

warningMsg · string | null

weeklyScheduleData · object

Weekly repeating schedule data type with usage information.

Show child attributes