Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
Users
Functions for managing users.
Function Summary
Name Path Version Description

editUserV30

/users/edit

3.0

Edits user in context of organization.

getClassificationsV30

/users/classifications

3.0

Gets a list of all classifications for the current user, for all workspaces the user has access to.

sendEmailV30

/users/sendEmail

3.0

Sends Email.

Function Details

editUserV30

Edits user in context of organization.

Version: 3.0
Synopsis: POST
Path: /users/edit
Request Body: EditUser
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /users/edit

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

{
userName: String,
sendNotifications: Boolean,
timezoneOffset: Integer,
updateUserName: Boolean,
updateSendNotifications: Boolean,
updateTimezoneOffset: Boolean,
language: 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
}

getClassificationsV30

Gets a list of all classifications for the current user, for all workspaces the user has access to.

Version: 3.0
Synopsis: GET
Path: /users/classifications
Request Body: N/A
Response Headers: N/A
Response Body: ItemListJson of type Classification

Request format:

GET /users/classifications

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

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

sendEmailV30

Sends Email.

Version: 3.0
Synopsis: POST
Path: /users/sendEmail
Request Body: SendEmail
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /users/sendEmail

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

{
recipients: List(String),
subject: String,
note: String,
onBehalfOf: String,
readConfirmation: 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
}