Platform API

<back to all web services

GetSuiteNotifications

Get notifications for the specified suite

Requires Authentication
The following routes are available for this service:
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"SuiteId":"00000000-0000-0000-0000-000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Notifications":[{"NotificationId":"00000000-0000-0000-0000-000000000000","NotificationGroupId":"00000000-0000-0000-0000-000000000000","NotificationGroupName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","SuiteName":"String","NotificationValueId":"00000000-0000-0000-0000-000000000000","Roles":[{"RoleId":"00000000-0000-0000-0000-000000000000","RoleName":"String"}],"RolesToDisplay":"String","Name":"String","Description":"String","IsMandatory":false,"IsCardinality":false,"IsSystem":false,"IsAudit":false,"IsVisibleToRecipients":false,"IsSingleUse":false,"Email":false,"EmailDefault":false,"EmailTemplateId":"00000000-0000-0000-0000-000000000000","EmailTemplateBody":"String","EmailSubject":"String","SMS":false,"SMSDefault":false,"SMSTemplateId":"00000000-0000-0000-0000-000000000000","SMSTemplateBody":"String","UpdateNotification":false,"UpdateNotificationDefault":false,"UpdateTemplateId":"00000000-0000-0000-0000-000000000000","UpdateTemplateBody":"String","UpdateSubject":"String","Push":false,"PushDefault":false,"Phone":false,"PhoneDefault":false,"ContactIdOwner":"00000000-0000-0000-0000-000000000000","RecordStatus":"String","EmailTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","SMSTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","UpdateTemplateDefinitionId":"00000000-0000-0000-0000-000000000000","Index":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}