| GET | /api/automation/notification/{ObjectId}/roles |
|---|
"use strict";
export class GroupedListItemModel {
/** @param {{ListItemId?:string,Name?:string,GroupId?:string,GroupName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListItemId;
/** @type {string} */
Name;
/** @type {string} */
GroupId;
/** @type {string} */
GroupName;
}
export class GetRolesForAutomationNotificationsResponse {
/** @param {{AllRoles?:GroupedListItemModel[],RolesUsedEmail?:string[],RolesUsedSMS?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GroupedListItemModel[]}
* @description List of all roles (grouped by suite) that can be assigned to a notification. */
AllRoles;
/**
* @type {string[]}
* @description List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. */
RolesUsedEmail;
/**
* @type {string[]}
* @description List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. */
RolesUsedSMS;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetRolesForAutomationNotifications extends GetRolesForAutomationNotificationsResponse {
/** @param {{ObjectId?:string,AllRoles?:GroupedListItemModel[],RolesUsedEmail?:string[],RolesUsedSMS?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Object the notification will be for. Used to exclude any currently assigned roles. */
ObjectId;
}
JavaScript GetRolesForAutomationNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetRolesForAutomationNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<AllRoles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:GroupedListItemModel>
<d2p1:GroupId>00000000-0000-0000-0000-000000000000</d2p1:GroupId>
<d2p1:GroupName>String</d2p1:GroupName>
<d2p1:ListItemId>00000000-0000-0000-0000-000000000000</d2p1:ListItemId>
<d2p1:Name>String</d2p1:Name>
</d2p1:GroupedListItemModel>
</AllRoles>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<RolesUsedEmail xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</RolesUsedEmail>
<RolesUsedSMS xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</RolesUsedSMS>
</GetRolesForAutomationNotificationsResponse>