| 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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Notifications:
[
{
NotificationGroupName: String,
SuiteName: String,
Roles:
[
{
RoleName: String
}
],
RolesToDisplay: String,
Name: String,
Description: String,
IsMandatory: False,
IsCardinality: False,
IsSystem: False,
IsAudit: False,
IsVisibleToRecipients: False,
IsSingleUse: False,
Email: False,
EmailDefault: False,
EmailTemplateBody: String,
EmailSubject: String,
SMS: False,
SMSDefault: False,
SMSTemplateBody: String,
UpdateNotification: False,
UpdateNotificationDefault: False,
UpdateTemplateBody: String,
UpdateSubject: String,
Push: False,
PushDefault: False,
Phone: False,
PhoneDefault: False,
RecordStatus: String,
Index: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}