Skip to main content
POST
/
api
/
schedule
/
getScheduleData
Get schedule data
curl --request POST \
  --url https://api2.rhombussystems.com/api/schedule/getScheduleData \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "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"
      ],
      "strategy": "WEEKLY_REPEATING_MINUTES",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting all schedules.

Response

200 - application/json

OK

Response object for getting schedule data.

error
boolean | null
errorMsg
string | null
warningMsg
string | null
weeklyScheduleData
object[] | null

List of weekly schedule data