Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
Notifications
Functions for managing notifications.
Function Summary
Name Path Version Description

deleteEmbeddedNotificationsV30

/notifications/embedded/delete

3.0

deleteNotificationsV30

/notifications/delete

3.0

Deletes the user's notifications.

getNotificationsV30

/notifications/list

3.0

Lists the user's notifications.

getTotalEmbeddedNotificationsV30

/notifications/embedded/all/list/count

3.0

getUserDeviceNotificationSettingsListV30

/notifications/user/device/notifications/settings/list

3.0

listAllEmbeddedNotificationsListV30

/notifications/embedded/all/list

3.0

listEmbeddedSummaryNotificationsListV30

/notifications/embedded/summary/list

3.0

markEmbeddedNotificationsV30

/notifications/embedded/mark

3.0

markNotificationsV30

/notifications/mark

3.0

Marks the user's notifications.

setHideUserNotificationsV30

/notifications/hide

3.0

setUserDeviceNotificationSettingsV30

/notifications/user/device/notifications/settings/set

3.0

setUserWorkspaceNotificationSettingsV30

/notifications/user/workspace/notifications/settings/set

3.0

Function Details

deleteEmbeddedNotificationsV30

Version: 3.0
Synopsis: POST
Path: /notifications/embedded/delete
Request Body: DeleteEmbeddedNotification
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/embedded/delete

Authorization: Bearer <ssid>

{
uuids: Set(String),
filter: String,
all: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteNotificationsV30

Deletes the user's notifications.

Version: 3.0
Synopsis: POST
Path: /notifications/delete
Request Body: DeleteNotification
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/delete

Authorization: Bearer <ssid>

{
uuids: Set(String),
all: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

getNotificationsV30

Lists the user's notifications.

Version: 3.0
Synopsis: POST
Path: /notifications/list
Request Body: ListNotifications
Response Headers: N/A
Response Body: PagingItemListJson of type Notification

Request format:

POST /notifications/list

Authorization: Bearer <ssid>

{
paginationInfo:
{
pageSize: Integer,
pageNumber: Integer
},
includeRead: Boolean,
order: UserNotificationOrder,
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Notification )
}

getTotalEmbeddedNotificationsV30

Version: 3.0
Synopsis: POST
Path: /notifications/embedded/all/list/count
Request Body: TotalEmbeddedNotificationsRequest
Response Headers: N/A
Response Body: TotalEmbeddedNotificationsResponse of type EmbeddedNotification

Request format:

POST /notifications/embedded/all/list/count

Authorization: Bearer <ssid>
Content-type: application/json

{
deviceType: String,
filter: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
lastNotificationActionDate: Date
}

getUserDeviceNotificationSettingsListV30

Version: 3.0
Synopsis: POST
Path: /notifications/user/device/notifications/settings/list
Request Body: DeviceType
Response Headers: N/A
Response Body: UserDeviceNotificationTypeSettings

Request format:

POST /notifications/user/device/notifications/settings/list

Authorization: Bearer <ssid>
Content-type: application/json

{
deviceType: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
deviceType: String,
commentMentioned: Boolean,
commentReplied: Boolean,
sharedFile: Boolean,
editFile: Boolean,
pendingPermissionRequest: Boolean,
otherNotifications: Boolean
}

listAllEmbeddedNotificationsListV30

Version: 3.0
Synopsis: POST
Path: /notifications/embedded/all/list
Request Body: ListAllNotifications
Response Headers: N/A
Response Body: ItemListJson of type EmbeddedNotification

Request format:

POST /notifications/embedded/all/list

Authorization: Bearer <ssid>
Content-type: application/json

{
paginationJson:
{
pageSize: Integer,
pageNumber: Integer
},
orderAscending: Boolean,
deviceType: String,
filter: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(EmbeddedNotification )
}

listEmbeddedSummaryNotificationsListV30

Version: 3.0
Synopsis: POST
Path: /notifications/embedded/summary/list
Request Body: ListSummaryEmbeddedNotification
Response Headers: N/A
Response Body: ItemListJson of type SummaryEmbeddedNotification

Request format:

POST /notifications/embedded/summary/list

Authorization: Bearer <ssid>
Content-type: application/json

{
pageSize: Integer,
deviceType: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(SummaryEmbeddedNotification )
}

markEmbeddedNotificationsV30

Version: 3.0
Synopsis: POST
Path: /notifications/embedded/mark
Request Body: MarkEmbeddedNotification
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/embedded/mark

Authorization: Bearer <ssid>

{
all: Boolean,
uuids: Set(String),
operation: String,
value: Boolean,
filter: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

markNotificationsV30

Marks the user's notifications.

Version: 3.0
Synopsis: POST
Path: /notifications/mark
Request Body: MarkNotification
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/mark

Authorization: Bearer <ssid>

{
all: Boolean,
uuids: Set(String),
operation: String,
value: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

setHideUserNotificationsV30

Version: 3.0
Synopsis: POST
Path: /notifications/hide
Request Body: HideNotification
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/hide

Authorization: Bearer <ssid>
Content-type: application/json

{
notificationUuids: Set(String),
filter: String,
allNotifications: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

setUserDeviceNotificationSettingsV30

Version: 3.0
Synopsis: POST
Path: /notifications/user/device/notifications/settings/set
Request Body: UserDeviceNotificationTypeSettings
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/user/device/notifications/settings/set

Authorization: Bearer <ssid>
Content-type: application/json

{
deviceType: String,
commentMentioned: Boolean,
commentReplied: Boolean,
sharedFile: Boolean,
editFile: Boolean,
pendingPermissionRequest: Boolean,
otherNotifications: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

setUserWorkspaceNotificationSettingsV30

Version: 3.0
Synopsis: POST
Path: /notifications/user/workspace/notifications/settings/set
Request Body: ListUserWorkspaceNotificationsSettings
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /notifications/user/workspace/notifications/settings/set

Authorization: Bearer <ssid>
Content-type: application/json

{
userWorkspaceNotificationsSettings: Set(
{
workspaceUuid: String,
notificationsEnabled: Boolean
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}