Platform API

<back to all web services

GetSuiteNotifications

Get notifications for the specified suite

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Get notifications for the specified suite
    */
    @Api(Description="Get notifications for the specified suite")
    public static class GetSuiteNotifications
    {
        /**
        * Id of suite to get notifications for
        */
        @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")
        public UUID SuiteId = null;
        
        public UUID getSuiteId() { return SuiteId; }
        public GetSuiteNotifications setSuiteId(UUID value) { this.SuiteId = value; return this; }
    }

    @ApiResponse(Description="List of suite notifications")
    public static class GetSuiteNotificationsResponse
    {
        public ArrayList<Notification> Notifications = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<Notification> getNotifications() { return Notifications; }
        public GetSuiteNotificationsResponse setNotifications(ArrayList<Notification> value) { this.Notifications = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public GetSuiteNotificationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class Notification
    {
        public UUID NotificationId = null;
        public UUID NotificationGroupId = null;
        public String NotificationGroupName = null;
        public UUID SuiteId = null;
        public String SuiteName = null;
        public UUID NotificationValueId = null;
        public ArrayList<NotificationRole> Roles = null;
        public String RolesToDisplay = null;
        public String Name = null;
        public String Description = null;
        public Boolean IsMandatory = null;
        public Boolean IsCardinality = null;
        public Boolean IsSystem = null;
        public Boolean IsAudit = null;
        public Boolean IsVisibleToRecipients = null;
        public Boolean IsSingleUse = null;
        public Boolean Email = null;
        public Boolean EmailDefault = null;
        public UUID EmailTemplateId = null;
        public String EmailTemplateBody = null;
        public String EmailSubject = null;
        public Boolean SMS = null;
        public Boolean SMSDefault = null;
        public UUID SMSTemplateId = null;
        public String SMSTemplateBody = null;
        public Boolean UpdateNotification = null;
        public Boolean UpdateNotificationDefault = null;
        public UUID UpdateTemplateId = null;
        public String UpdateTemplateBody = null;
        public String UpdateSubject = null;
        public Boolean Push = null;
        public Boolean PushDefault = null;
        public Boolean Phone = null;
        public Boolean PhoneDefault = null;
        public UUID ContactIdOwner = null;
        public String RecordStatus = null;
        public UUID EmailTemplateDefinitionId = null;
        public UUID SMSTemplateDefinitionId = null;
        public UUID UpdateTemplateDefinitionId = null;
        public Integer Index = null;
        
        public UUID getNotificationId() { return NotificationId; }
        public Notification setNotificationId(UUID value) { this.NotificationId = value; return this; }
        public UUID getNotificationGroupId() { return NotificationGroupId; }
        public Notification setNotificationGroupId(UUID value) { this.NotificationGroupId = value; return this; }
        public String getNotificationGroupName() { return NotificationGroupName; }
        public Notification setNotificationGroupName(String value) { this.NotificationGroupName = value; return this; }
        public UUID getSuiteId() { return SuiteId; }
        public Notification setSuiteId(UUID value) { this.SuiteId = value; return this; }
        public String getSuiteName() { return SuiteName; }
        public Notification setSuiteName(String value) { this.SuiteName = value; return this; }
        public UUID getNotificationValueId() { return NotificationValueId; }
        public Notification setNotificationValueId(UUID value) { this.NotificationValueId = value; return this; }
        public ArrayList<NotificationRole> getRoles() { return Roles; }
        public Notification setRoles(ArrayList<NotificationRole> value) { this.Roles = value; return this; }
        public String getRolesToDisplay() { return RolesToDisplay; }
        public Notification setRolesToDisplay(String value) { this.RolesToDisplay = value; return this; }
        public String getName() { return Name; }
        public Notification setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public Notification setDescription(String value) { this.Description = value; return this; }
        public Boolean getIsMandatory() { return IsMandatory; }
        public Notification setIsMandatory(Boolean value) { this.IsMandatory = value; return this; }
        public Boolean getIsCardinality() { return IsCardinality; }
        public Notification setIsCardinality(Boolean value) { this.IsCardinality = value; return this; }
        public Boolean getIsSystem() { return IsSystem; }
        public Notification setIsSystem(Boolean value) { this.IsSystem = value; return this; }
        public Boolean getIsAudit() { return IsAudit; }
        public Notification setIsAudit(Boolean value) { this.IsAudit = value; return this; }
        public Boolean getIsVisibleToRecipients() { return IsVisibleToRecipients; }
        public Notification setIsVisibleToRecipients(Boolean value) { this.IsVisibleToRecipients = value; return this; }
        public Boolean getIsSingleUse() { return IsSingleUse; }
        public Notification setIsSingleUse(Boolean value) { this.IsSingleUse = value; return this; }
        public Boolean isEmail() { return Email; }
        public Notification setEmail(Boolean value) { this.Email = value; return this; }
        public Boolean isEmailDefault() { return EmailDefault; }
        public Notification setEmailDefault(Boolean value) { this.EmailDefault = value; return this; }
        public UUID getEmailTemplateId() { return EmailTemplateId; }
        public Notification setEmailTemplateId(UUID value) { this.EmailTemplateId = value; return this; }
        public String getEmailTemplateBody() { return EmailTemplateBody; }
        public Notification setEmailTemplateBody(String value) { this.EmailTemplateBody = value; return this; }
        public String getEmailSubject() { return EmailSubject; }
        public Notification setEmailSubject(String value) { this.EmailSubject = value; return this; }
        public Boolean isSms() { return SMS; }
        public Notification setSms(Boolean value) { this.SMS = value; return this; }
        public Boolean isSmsDefault() { return SMSDefault; }
        public Notification setSmsDefault(Boolean value) { this.SMSDefault = value; return this; }
        public UUID getSmsTemplateId() { return SMSTemplateId; }
        public Notification setSmsTemplateId(UUID value) { this.SMSTemplateId = value; return this; }
        public String getSmsTemplateBody() { return SMSTemplateBody; }
        public Notification setSmsTemplateBody(String value) { this.SMSTemplateBody = value; return this; }
        public Boolean isUpdateNotification() { return UpdateNotification; }
        public Notification setUpdateNotification(Boolean value) { this.UpdateNotification = value; return this; }
        public Boolean isUpdateNotificationDefault() { return UpdateNotificationDefault; }
        public Notification setUpdateNotificationDefault(Boolean value) { this.UpdateNotificationDefault = value; return this; }
        public UUID getUpdateTemplateId() { return UpdateTemplateId; }
        public Notification setUpdateTemplateId(UUID value) { this.UpdateTemplateId = value; return this; }
        public String getUpdateTemplateBody() { return UpdateTemplateBody; }
        public Notification setUpdateTemplateBody(String value) { this.UpdateTemplateBody = value; return this; }
        public String getUpdateSubject() { return UpdateSubject; }
        public Notification setUpdateSubject(String value) { this.UpdateSubject = value; return this; }
        public Boolean isPush() { return Push; }
        public Notification setPush(Boolean value) { this.Push = value; return this; }
        public Boolean isPushDefault() { return PushDefault; }
        public Notification setPushDefault(Boolean value) { this.PushDefault = value; return this; }
        public Boolean isPhone() { return Phone; }
        public Notification setPhone(Boolean value) { this.Phone = value; return this; }
        public Boolean isPhoneDefault() { return PhoneDefault; }
        public Notification setPhoneDefault(Boolean value) { this.PhoneDefault = value; return this; }
        public UUID getContactIdOwner() { return ContactIdOwner; }
        public Notification setContactIdOwner(UUID value) { this.ContactIdOwner = value; return this; }
        public String getRecordStatus() { return RecordStatus; }
        public Notification setRecordStatus(String value) { this.RecordStatus = value; return this; }
        public UUID getEmailTemplateDefinitionId() { return EmailTemplateDefinitionId; }
        public Notification setEmailTemplateDefinitionId(UUID value) { this.EmailTemplateDefinitionId = value; return this; }
        public UUID getSmsTemplateDefinitionId() { return SMSTemplateDefinitionId; }
        public Notification setSmsTemplateDefinitionId(UUID value) { this.SMSTemplateDefinitionId = value; return this; }
        public UUID getUpdateTemplateDefinitionId() { return UpdateTemplateDefinitionId; }
        public Notification setUpdateTemplateDefinitionId(UUID value) { this.UpdateTemplateDefinitionId = value; return this; }
        public Integer getIndex() { return Index; }
        public Notification setIndex(Integer value) { this.Index = value; return this; }
    }

    public static class NotificationRole
    {
        public UUID RoleId = null;
        public String RoleName = null;
        
        public UUID getRoleId() { return RoleId; }
        public NotificationRole setRoleId(UUID value) { this.RoleId = value; return this; }
        public String getRoleName() { return RoleName; }
        public NotificationRole setRoleName(String value) { this.RoleName = value; return this; }
    }

}

Java GetSuiteNotifications DTOs

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>