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.

Dezrez.Core.DataContracts.External.NotificationService.UserNotification.UserNotification
NameDescriptionTypeAdditional information
NotificationTitle

string

None.

MessageContent

string

None.

AssociatedLinks

Collection of Dezrez.Core.DataContracts.External.SecurityAwareLink

None.

JobReference

globally unique identifier

None.

JobStatusText

string

None.

JobStatus

string

None.

JobPercentageCompleted

integer

None.

MessageType

string

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "a83345f6-d0c5-4ad9-ab78-cec9dba303f7",
  "JobStatusText": "sample string 4",
  "JobStatus": "sample string 5",
  "JobPercentageCompleted": 6,
  "MessageType": "Dezrez.Core.DataContracts.External.NotificationService.UserNotification.UserNotification"
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.