| GET | /api/automation/notification/{ObjectId}/roles |
|---|
import Foundation
import ServiceStack
/**
* 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.")
public 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")
public var objectId:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case objectId
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
objectId = try container.decodeIfPresent(String.self, forKey: .objectId)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if objectId != nil { try container.encode(objectId, forKey: .objectId) }
}
}
// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
public class GetRolesForAutomationNotificationsResponse : Codable
{
/**
* 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.")
public var allRoles:[GroupedListItemModel]
/**
* 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.")
public var rolesUsedEmail:[String]
/**
* 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.")
public var rolesUsedSMS:[String]
public var responseStatus:ResponseStatus
required public init(){}
}
public class GroupedListItemModel : Codable
{
public var listItemId:String
public var name:String
public var groupId:String
public var groupName:String
required public init(){}
}
Swift GetRolesForAutomationNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}