POST api/admin/system/sendNotificationToAllUsersInAgency?agencyId={agencyId}

Send a live notification to all active users in an agency

Request Information

URI Parameters

NameDescriptionTypeAdditional information
agencyId

The agency identifier.

integer

Required

Body Parameters

The send notification.

UserNotification
NameDescriptionTypeAdditional information
NotificationTitle

string

None.

MessageContent

string

None.

AssociatedLinks

Collection of SecurityAwareLink

None.

JobReference

globally unique identifier

None.

JobStatusText

string

None.

JobStatus

string

None.

JobPercentageCompleted

integer

None.

MessageType

string

None.

Request Formats

application/json, text/json

Sample:
{
  "NotificationTitle": "sample string 1",
  "MessageContent": "sample string 2",
  "AssociatedLinks": [
    {
      "LinkText": "sample string 1",
      "LinkAddress": "sample string 2",
      "RequiresAuthentication": true,
      "OpenInNewTab": true
    },
    {
      "LinkText": "sample string 1",
      "LinkAddress": "sample string 2",
      "RequiresAuthentication": true,
      "OpenInNewTab": true
    }
  ],
  "JobReference": "fe94ea9c-afb7-4aca-9211-8a000aad7de9",
  "JobStatusText": "sample string 4",
  "JobStatus": "sample string 5",
  "JobPercentageCompleted": 6,
  "MessageType": "Dezrez.Core.DataContracts.External.NotificationService.UserNotification.UserNotification"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.