| GET | /api/automation/notification/{ObjectId}/roles |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get eligible roles for automation notifications
*/
@Api(Description="Get eligible roles for automation notifications")
@ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
open class GetRolesForAutomationNotifications : GetRolesForAutomationNotificationsResponse()
{
/**
* Object the notification will be for. Used to exclude any currently assigned roles.
*/
@ApiMember(Description="Object the notification will be for. Used to exclude any currently assigned roles.", ParameterType="path")
open var ObjectId:UUID? = null
}
@ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
open class GetRolesForAutomationNotificationsResponse
{
/**
* List of all roles (grouped by suite) that can be assigned to a notification.
*/
@ApiMember(Description="List of all roles (grouped by suite) that can be assigned to a notification.")
open var AllRoles:ArrayList<GroupedListItemModel>? = null
/**
* List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.
*/
@ApiMember(Description="List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.")
open var RolesUsedEmail:ArrayList<UUID>? = null
/**
* List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.
*/
@ApiMember(Description="List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.")
open var RolesUsedSMS:ArrayList<UUID>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class GroupedListItemModel
{
open var ListItemId:UUID? = null
open var Name:String? = null
open var GroupId:UUID? = null
open var GroupName:String? = null
}
Kotlin GetRolesForAutomationNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}