| GET | /api/automation/notification/{ObjectId}/roles |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* 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 static class GetRolesForAutomationNotifications extends 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 UUID ObjectId = null;
public UUID getObjectId() { return ObjectId; }
public GetRolesForAutomationNotifications setObjectId(UUID value) { this.ObjectId = value; return this; }
}
@ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
public static 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.")
public ArrayList<GroupedListItemModel> AllRoles = 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.")
public ArrayList<UUID> RolesUsedEmail = 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.")
public ArrayList<UUID> RolesUsedSMS = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<GroupedListItemModel> getAllRoles() { return AllRoles; }
public GetRolesForAutomationNotificationsResponse setAllRoles(ArrayList<GroupedListItemModel> value) { this.AllRoles = value; return this; }
public ArrayList<UUID> getRolesUsedEmail() { return RolesUsedEmail; }
public GetRolesForAutomationNotificationsResponse setRolesUsedEmail(ArrayList<UUID> value) { this.RolesUsedEmail = value; return this; }
public ArrayList<UUID> getRolesUsedSMS() { return RolesUsedSMS; }
public GetRolesForAutomationNotificationsResponse setRolesUsedSMS(ArrayList<UUID> value) { this.RolesUsedSMS = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetRolesForAutomationNotificationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class GroupedListItemModel
{
public UUID ListItemId = null;
public String Name = null;
public UUID GroupId = null;
public String GroupName = null;
public UUID getListItemId() { return ListItemId; }
public GroupedListItemModel setListItemId(UUID value) { this.ListItemId = value; return this; }
public String getName() { return Name; }
public GroupedListItemModel setName(String value) { this.Name = value; return this; }
public UUID getGroupId() { return GroupId; }
public GroupedListItemModel setGroupId(UUID value) { this.GroupId = value; return this; }
public String getGroupName() { return GroupName; }
public GroupedListItemModel setGroupName(String value) { this.GroupName = value; return this; }
}
}
Java 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"}}}