Platform API

GetSuiteNotifications

Get notifications for the specified suite

The following routes are available for this service:
All Verbs	/api/suitenotifications

**GetSuiteNotifications** Parameters:
Name	Parameter	Data Type	Required	Description
SuiteId	query	Guid	Yes	Id of suite to get notifications for

**GetSuiteNotificationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Notifications	form	List<Notification>	No
ResponseStatus	form	ResponseStatus	No

**Notification** Parameters:
Name	Parameter	Data Type	Required
NotificationId	form	Guid	No
NotificationGroupId	form	Guid	No
NotificationGroupName	form	string	No
SuiteId	form	Guid	No
SuiteName	form	string	No
NotificationValueId	form	Guid	No
Roles	form	List<NotificationRole>	No
RolesToDisplay	form	string	No
Name	form	string	No
Description	form	string	No
IsMandatory	form	bool	No
IsCardinality	form	bool	No
IsSystem	form	bool	No
IsAudit	form	bool	No
IsVisibleToRecipients	form	bool	No
IsSingleUse	form	bool	No
Email	form	bool	No
EmailDefault	form	bool	No
EmailTemplateId	form	Guid	No
EmailTemplateBody	form	string	No
EmailSubject	form	string	No
SMS	form	bool	No
SMSDefault	form	bool	No
SMSTemplateId	form	Guid	No
SMSTemplateBody	form	string	No
UpdateNotification	form	bool	No
UpdateNotificationDefault	form	bool	No
UpdateTemplateId	form	Guid	No
UpdateTemplateBody	form	string	No
UpdateSubject	form	string	No
Push	form	bool	No
PushDefault	form	bool	No
Phone	form	bool	No
PhoneDefault	form	bool	No
ContactIdOwner	form	Guid	No
RecordStatus	form	string	No
EmailTemplateDefinitionId	form	Guid	No
SMSTemplateDefinitionId	form	Guid	No
UpdateTemplateDefinitionId	form	Guid	No
Index	form	int	No

**NotificationRole** Parameters:
Name	Parameter	Data Type	Required	Description
RoleId	form	Guid	No
RoleName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}