Loading
Documentation Powered by ReDoc

DFS Notification Services API (latest)

Download OpenAPI specification:Download

Contains functionality for managing notification data.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

Common

Get enumerations from multiple tables

Retrieves a list of enumerations for multiple tables. The tables available are:

NotificationChannel, NotificationRecipientType, SeverityLevel

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request data.

enumerationTypes
Array of strings (EnumerationType) Nullable
Items Enum: "NotificationChannel" "NotificationRecipientType" "SeverityLevel"

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/notifications/enumerations
https://example-host/v2.0/notifications/enumerations

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enumerationTypes":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "enumerations":
    [
    ]
}

NotificationManagement

Delete notification type

Deletes a notification type by ID.

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The ID of the notification type to retrieve

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v2.0/notifications/notificationtypes/{notificationTypeId}
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Modify notification type

Modifies an existing notification type.

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The ID of the notification type to modify

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The parameter DTO

updateProperties
Array of strings Nullable
name
string Nullable
severityLevelKey
string (SeverityLevelKey)
Enum: "Low" "Medium" "High"
notificationEventId
string Nullable
isActive
boolean
customAttributes
string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v2.0/notifications/notificationtypes/{notificationTypeId}
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "updateProperties":
    [
    ],
  • "name": "string",
  • "severityLevelKey": "Low",
  • "notificationEventId": "string",
  • "isActive": true,
  • "customAttributes": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Remove notification type from ignore list

Removes a notification type and channel pair from ignore list.

Authorizations:
Bearer
path Parameters
personUId
required
string <uuid>

Person UId for who the notification type will be removed from the ignored list

notificationTypeId
required
integer <int32>

The ID of the notification type

notificationChannelKey
required
string (NotificationChannelKey)
Enum: "Realtime" "Email" "Message" "Sms" "Push"

The notification channel key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v2.0/notificationsignorelist/person/{personUId}/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}
https://example-host/v2.0/notificationsignorelist/person/{personUId}/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Add notification type to ignore list

Adds a notification type and channel pair to ignore list.

Authorizations:
Bearer
path Parameters
personUId
required
string <uuid>

Person UId for who the notification type and channel pair will be added to the ignored list

notificationTypeId
required
integer <int32>

The ID of the notification type

notificationChannelKey
required
string (NotificationChannelKey)
Enum: "Realtime" "Email" "Message" "Sms" "Push"

The notification channel key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/notificationsignorelist/person/{personUId}/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}
https://example-host/v2.0/notificationsignorelist/person/{personUId}/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Delete channel for notification type

Deletes a channel for a notification type

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The Notification Type Id

notificationChannelKey
required
string (NotificationChannelKey)
Enum: "Realtime" "Email" "Message" "Sms" "Push"

The notification channel key

recipientTypeKey
required
string (NotificationRecipientTypeKey)
Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom"

The recipient type key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

delete/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}/recipienttypes/{recipientTypeKey}
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}/recipienttypes/{recipientTypeKey}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Update channel for recipient of a notification type

Updates a channel for the recipient of a notification type

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The Notification Type Id

notificationChannelKey
required
string (NotificationChannelKey)
Enum: "Realtime" "Email" "Message" "Sms" "Push"

The notification channel key

recipientTypeKey
required
string (NotificationRecipientTypeKey)
Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom"

The recipient type key

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The request object

updateProperties
Array of strings Nullable
renderTemplateMetadataUId
string <uuid>
isPersisted
boolean
isActive
boolean
appId
string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

patch/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}/recipienttypes/{recipientTypeKey}
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels/{notificationChannelKey}/recipienttypes/{recipientTypeKey}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "updateProperties":
    [
    ],
  • "renderTemplateMetadataUId": "string",
  • "isPersisted": true,
  • "isActive": true,
  • "appId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get notification types

Gets all notification types.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v2.0/notifications/notificationtypes
https://example-host/v2.0/notifications/notificationtypes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "notificationTypes":
    [
    ]
}

Create notification type

Creates a new notification type.

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the notification type to create

name
string Nullable
severityLevelKey
string (SeverityLevelKey)
Enum: "Low" "Medium" "High"
notificationEventId
string Nullable
isActive
boolean
customAttributes
string Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/notifications/notificationtypes
https://example-host/v2.0/notifications/notificationtypes

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "severityLevelKey": "Low",
  • "notificationEventId": "string",
  • "isActive": true,
  • "customAttributes": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 0
}

Get ignored notification types

Gets all ignored notification types.

Authorizations:
Bearer
path Parameters
personUId
required
string <uuid>
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v2.0/notificationsignorelist/person/{personUId}
https://example-host/v2.0/notificationsignorelist/person/{personUId}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ignoredNotificationTypes":
    [
    ]
}

Update ignore list

Updates the entire notifications ignore list of the person.

Authorizations:
Bearer
path Parameters
personUId
required
string <uuid>

Person UId for who the notification ignore list will be updated

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The notification types and notification channels pairs to be updated

ignoredNotifications
Array of objects (NotificationTypeNotificationChannel) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

put/v2.0/notificationsignorelist/person/{personUId}
https://example-host/v2.0/notificationsignorelist/person/{personUId}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ignoredNotifications":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Get channels for notification type

Gets all the channels configured for a notification type

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The Notification Type Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

get/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "notificationTypeChannels":
    [
    ]
}

Create channel for notification type

Creates a new channel for a notification type

Authorizations:
Bearer
path Parameters
notificationTypeId
required
integer <int32>

The Notification Type Id

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The request object

notificationChannelKey
string (NotificationChannelKey)
Enum: "Realtime" "Email" "Message" "Sms" "Push"
renderTemplateMetadataUId
string <uuid>
notificationRecipientTypeKey
string (NotificationRecipientTypeKey)
Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom"
isPersisted
boolean
isActive
boolean
appId
string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels
https://example-host/v2.0/notifications/notificationtypes/{notificationTypeId}/notificationchannels

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "notificationChannelKey": "Realtime",
  • "renderTemplateMetadataUId": "string",
  • "notificationRecipientTypeKey": "Initiator",
  • "isPersisted": true,
  • "isActive": true,
  • "appId": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "General",
  • "subCode": "string",
  • "message": "string",
  • "correlationId": "string",
  • "properties":
    {
    }
}

Return channels

Returns channels for a given set of parameters

Authorizations:
Bearer
header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The request object

notificationTypeIds
Array of integers <int32> Nullable
notificationChannelKeys
Array of strings (NotificationChannelKey) Nullable
Items Enum: "Realtime" "Email" "Message" "Sms" "Push"
notificationRecipientTypeKeys
Array of strings (NotificationRecipientTypeKey) Nullable
Items Enum: "Initiator" "Contact" "Member" "ContactGroup" "Custom"
renderTemplateMetadataUIds
Array of strings <uuid> Nullable
appIds
Array of strings Nullable

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Internal Server Error

post/v2.0/notifications/notificationchannels/search
https://example-host/v2.0/notifications/notificationchannels/search

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "notificationTypeIds":
    [
    ],
  • "notificationChannelKeys":
    [
    ],
  • "notificationRecipientTypeKeys":
    [
    ],
  • "renderTemplateMetadataUIds":
    [
    ],
  • "appIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "notificationTypeChannels":
    [
    ]
}