Schedule Webservice

Get schedule data V2

Get weekly schedules in org with usage data

post/api/schedule/getScheduleDataV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/schedule/getScheduleDataV2
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

scheduleUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "weeklyScheduleData": {
    "accessGrantUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "alarmMonitoringUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "alertPolicyUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "customEventUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "doorSettingUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "locationsUsedIn": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ruleUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "sharedStreamUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.