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
"use strict";
export class NotificationRole {
    /** @param {{RoleId?:string,RoleName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RoleId;
    /** @type {string} */
    RoleName;
}
export class Notification {
    /** @param {{NotificationId?:string,NotificationGroupId?:string,NotificationGroupName?:string,SuiteId?:string,SuiteName?:string,NotificationValueId?:string,Roles?:NotificationRole[],RolesToDisplay?:string,Name?:string,Description?:string,IsMandatory?:boolean,IsCardinality?:boolean,IsSystem?:boolean,IsAudit?:boolean,IsVisibleToRecipients?:boolean,IsSingleUse?:boolean,Email?:boolean,EmailDefault?:boolean,EmailTemplateId?:string,EmailTemplateBody?:string,EmailSubject?:string,SMS?:boolean,SMSDefault?:boolean,SMSTemplateId?:string,SMSTemplateBody?:string,UpdateNotification?:boolean,UpdateNotificationDefault?:boolean,UpdateTemplateId?:string,UpdateTemplateBody?:string,UpdateSubject?:string,Push?:boolean,PushDefault?:boolean,Phone?:boolean,PhoneDefault?:boolean,ContactIdOwner?:string,RecordStatus?:string,EmailTemplateDefinitionId?:string,SMSTemplateDefinitionId?:string,UpdateTemplateDefinitionId?:string,Index?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    NotificationId;
    /** @type {string} */
    NotificationGroupId;
    /** @type {string} */
    NotificationGroupName;
    /** @type {string} */
    SuiteId;
    /** @type {string} */
    SuiteName;
    /** @type {string} */
    NotificationValueId;
    /** @type {NotificationRole[]} */
    Roles;
    /** @type {string} */
    RolesToDisplay;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    IsMandatory;
    /** @type {boolean} */
    IsCardinality;
    /** @type {boolean} */
    IsSystem;
    /** @type {boolean} */
    IsAudit;
    /** @type {boolean} */
    IsVisibleToRecipients;
    /** @type {boolean} */
    IsSingleUse;
    /** @type {boolean} */
    Email;
    /** @type {boolean} */
    EmailDefault;
    /** @type {string} */
    EmailTemplateId;
    /** @type {string} */
    EmailTemplateBody;
    /** @type {string} */
    EmailSubject;
    /** @type {boolean} */
    SMS;
    /** @type {boolean} */
    SMSDefault;
    /** @type {string} */
    SMSTemplateId;
    /** @type {string} */
    SMSTemplateBody;
    /** @type {boolean} */
    UpdateNotification;
    /** @type {boolean} */
    UpdateNotificationDefault;
    /** @type {string} */
    UpdateTemplateId;
    /** @type {string} */
    UpdateTemplateBody;
    /** @type {string} */
    UpdateSubject;
    /** @type {boolean} */
    Push;
    /** @type {boolean} */
    PushDefault;
    /** @type {boolean} */
    Phone;
    /** @type {boolean} */
    PhoneDefault;
    /** @type {string} */
    ContactIdOwner;
    /** @type {string} */
    RecordStatus;
    /** @type {string} */
    EmailTemplateDefinitionId;
    /** @type {string} */
    SMSTemplateDefinitionId;
    /** @type {string} */
    UpdateTemplateDefinitionId;
    /** @type {number} */
    Index;
}
export class GetSuiteNotificationsResponse {
    /** @param {{Notifications?:Notification[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Notification[]} */
    Notifications;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetSuiteNotifications {
    /** @param {{SuiteId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Id of suite to get notifications for */
    SuiteId;
}

JavaScript GetSuiteNotifications DTOs

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

HTTP + 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>