Org Webservice

Get organization notification template V2

Get organization's default notification schedule template

post/api/org/getOrgNotificationTemplateV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/org/getOrgNotificationTemplateV2
  • 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

OrgGetOrgNotificationTemplateWSRequest required

Request object for getting organization notification template.

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

{
  "notificationSettings": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "timeFrames": [
      {
        "rows": [
          {
            "devices": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "locationOnly": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "locations": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "promptUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ]
          }
        ]
      }
    ],
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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