| GET | /api/automation/notification/{ObjectId}/roles |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ObjectId | path | Guid | No | Object the notification will be for. Used to exclude any currently assigned roles. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllRoles | form | List<GroupedListItemModel> | No | List of all roles (grouped by suite) that can be assigned to a notification. |
| RolesUsedEmail | form | List<Guid> | No | List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. |
| RolesUsedSMS | form | List<Guid> | No | List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListItemId | form | Guid | No | |
| Name | form | string | No | |
| GroupId | form | Guid | No | |
| GroupName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AllRoles | form | List<GroupedListItemModel> | No | List of all roles (grouped by suite) that can be assigned to a notification. |
| RolesUsedEmail | form | List<Guid> | No | List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. |
| RolesUsedSMS | form | List<Guid> | No | List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/notification/{ObjectId}/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"AllRoles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","GroupId":"00000000-0000-0000-0000-000000000000","GroupName":"String"}],"RolesUsedEmail":["00000000-0000-0000-0000-000000000000"],"RolesUsedSMS":["00000000-0000-0000-0000-000000000000"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}