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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type NotificationRole() = 
        member val RoleId:Guid = new Guid() with get,set
        member val RoleName:String = null with get,set

    [<AllowNullLiteral>]
    type Notification() = 
        member val NotificationId:Guid = new Guid() with get,set
        member val NotificationGroupId:Guid = new Guid() with get,set
        member val NotificationGroupName:String = null with get,set
        member val SuiteId:Guid = new Guid() with get,set
        member val SuiteName:String = null with get,set
        member val NotificationValueId:Guid = new Guid() with get,set
        member val Roles:ResizeArray<NotificationRole> = null with get,set
        member val RolesToDisplay:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val IsMandatory:Boolean = new Boolean() with get,set
        member val IsCardinality:Boolean = new Boolean() with get,set
        member val IsSystem:Boolean = new Boolean() with get,set
        member val IsAudit:Boolean = new Boolean() with get,set
        member val IsVisibleToRecipients:Boolean = new Boolean() with get,set
        member val IsSingleUse:Boolean = new Boolean() with get,set
        member val Email:Boolean = new Boolean() with get,set
        member val EmailDefault:Boolean = new Boolean() with get,set
        member val EmailTemplateId:Guid = new Guid() with get,set
        member val EmailTemplateBody:String = null with get,set
        member val EmailSubject:String = null with get,set
        member val SMS:Boolean = new Boolean() with get,set
        member val SMSDefault:Boolean = new Boolean() with get,set
        member val SMSTemplateId:Guid = new Guid() with get,set
        member val SMSTemplateBody:String = null with get,set
        member val UpdateNotification:Boolean = new Boolean() with get,set
        member val UpdateNotificationDefault:Boolean = new Boolean() with get,set
        member val UpdateTemplateId:Guid = new Guid() with get,set
        member val UpdateTemplateBody:String = null with get,set
        member val UpdateSubject:String = null with get,set
        member val Push:Boolean = new Boolean() with get,set
        member val PushDefault:Boolean = new Boolean() with get,set
        member val Phone:Boolean = new Boolean() with get,set
        member val PhoneDefault:Boolean = new Boolean() with get,set
        member val ContactIdOwner:Guid = new Guid() with get,set
        member val RecordStatus:String = null with get,set
        member val EmailTemplateDefinitionId:Guid = new Guid() with get,set
        member val SMSTemplateDefinitionId:Guid = new Guid() with get,set
        member val UpdateTemplateDefinitionId:Guid = new Guid() with get,set
        member val Index:Int32 = new Int32() with get,set

    [<ApiResponse(Description="List of suite notifications")>]
    [<AllowNullLiteral>]
    type GetSuiteNotificationsResponse() = 
        member val Notifications:ResizeArray<Notification> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get notifications for the specified suite
    ///</summary>
    [<Api(Description="Get notifications for the specified suite")>]
    [<AllowNullLiteral>]
    type GetSuiteNotifications() = 
        ///<summary>
        ///Id of suite to get notifications for
        ///</summary>
        [<ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")>]
        member val SuiteId:Guid = new Guid() with get,set

F# 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>