| All Verbs | /api/suitenotifications |
|---|
export class NotificationRole
{
public RoleId: string;
public RoleName: string;
public constructor(init?: Partial<NotificationRole>) { (Object as any).assign(this, init); }
}
export class Notification
{
public NotificationId: string;
public NotificationGroupId: string;
public NotificationGroupName: string;
public SuiteId: string;
public SuiteName: string;
public NotificationValueId: string;
public Roles: NotificationRole[];
public RolesToDisplay: string;
public Name: string;
public Description: string;
public IsMandatory: boolean;
public IsCardinality: boolean;
public IsSystem: boolean;
public IsAudit: boolean;
public IsVisibleToRecipients: boolean;
public IsSingleUse: boolean;
public Email: boolean;
public EmailDefault: boolean;
public EmailTemplateId: string;
public EmailTemplateBody: string;
public EmailSubject: string;
public SMS: boolean;
public SMSDefault: boolean;
public SMSTemplateId: string;
public SMSTemplateBody: string;
public UpdateNotification: boolean;
public UpdateNotificationDefault: boolean;
public UpdateTemplateId: string;
public UpdateTemplateBody: string;
public UpdateSubject: string;
public Push: boolean;
public PushDefault: boolean;
public Phone: boolean;
public PhoneDefault: boolean;
public ContactIdOwner: string;
public RecordStatus: string;
public EmailTemplateDefinitionId: string;
public SMSTemplateDefinitionId: string;
public UpdateTemplateDefinitionId: string;
public Index: number;
public constructor(init?: Partial<Notification>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="List of suite notifications")
export class GetSuiteNotificationsResponse
{
public Notifications: Notification[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetSuiteNotificationsResponse>) { (Object as any).assign(this, init); }
}
/** @description Get notifications for the specified suite */
// @Api(Description="Get notifications for the specified suite")
export class GetSuiteNotifications
{
/** @description Id of suite to get notifications for */
// @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")
public SuiteId: string;
public constructor(init?: Partial<GetSuiteNotifications>) { (Object as any).assign(this, init); }
}
TypeScript GetSuiteNotifications 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.
POST /api/suitenotifications HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetSuiteNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</GetSuiteNotifications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSuiteNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:Notification>
<d2p1:ContactIdOwner>00000000-0000-0000-0000-000000000000</d2p1:ContactIdOwner>
<d2p1:Description>String</d2p1:Description>
<d2p1:Email>false</d2p1:Email>
<d2p1:EmailDefault>false</d2p1:EmailDefault>
<d2p1:EmailSubject>String</d2p1:EmailSubject>
<d2p1:EmailTemplateBody>String</d2p1:EmailTemplateBody>
<d2p1:EmailTemplateDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:EmailTemplateDefinitionId>
<d2p1:EmailTemplateId>00000000-0000-0000-0000-000000000000</d2p1:EmailTemplateId>
<d2p1:Index>0</d2p1:Index>
<d2p1:IsAudit>false</d2p1:IsAudit>
<d2p1:IsCardinality>false</d2p1:IsCardinality>
<d2p1:IsMandatory>false</d2p1:IsMandatory>
<d2p1:IsSingleUse>false</d2p1:IsSingleUse>
<d2p1:IsSystem>false</d2p1:IsSystem>
<d2p1:IsVisibleToRecipients>false</d2p1:IsVisibleToRecipients>
<d2p1:Name>String</d2p1:Name>
<d2p1:NotificationGroupId>00000000-0000-0000-0000-000000000000</d2p1:NotificationGroupId>
<d2p1:NotificationGroupName>String</d2p1:NotificationGroupName>
<d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
<d2p1:NotificationValueId>00000000-0000-0000-0000-000000000000</d2p1:NotificationValueId>
<d2p1:Phone>false</d2p1:Phone>
<d2p1:PhoneDefault>false</d2p1:PhoneDefault>
<d2p1:Push>false</d2p1:Push>
<d2p1:PushDefault>false</d2p1:PushDefault>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:Roles>
<d2p1:NotificationRole>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
</d2p1:NotificationRole>
</d2p1:Roles>
<d2p1:SMS>false</d2p1:SMS>
<d2p1:SMSDefault>false</d2p1:SMSDefault>
<d2p1:SMSTemplateBody>String</d2p1:SMSTemplateBody>
<d2p1:SMSTemplateDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:SMSTemplateDefinitionId>
<d2p1:SMSTemplateId>00000000-0000-0000-0000-000000000000</d2p1:SMSTemplateId>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
<d2p1:UpdateNotification>false</d2p1:UpdateNotification>
<d2p1:UpdateNotificationDefault>false</d2p1:UpdateNotificationDefault>
<d2p1:UpdateSubject>String</d2p1:UpdateSubject>
<d2p1:UpdateTemplateBody>String</d2p1:UpdateTemplateBody>
<d2p1:UpdateTemplateDefinitionId>00000000-0000-0000-0000-000000000000</d2p1:UpdateTemplateDefinitionId>
<d2p1:UpdateTemplateId>00000000-0000-0000-0000-000000000000</d2p1:UpdateTemplateId>
</d2p1:Notification>
</Notifications>
<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>
</GetSuiteNotificationsResponse>