Platform API

GetSuiteNotifications

Get notifications for the specified suite

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

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


/**
* Get notifications for the specified suite
*/
@Api(Description="Get notifications for the specified suite")
open class GetSuiteNotifications
{
    /**
    * Id of suite to get notifications for
    */
    @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")
    open var SuiteId:UUID? = null
}

@ApiResponse(Description="List of suite notifications")
open class GetSuiteNotificationsResponse
{
    open var Notifications:ArrayList<Notification>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class Notification
{
    open var NotificationId:UUID? = null
    open var NotificationGroupId:UUID? = null
    open var NotificationGroupName:String? = null
    open var SuiteId:UUID? = null
    open var SuiteName:String? = null
    open var NotificationValueId:UUID? = null
    open var Roles:ArrayList<NotificationRole>? = null
    open var RolesToDisplay:String? = null
    open var Name:String? = null
    open var Description:String? = null
    open var IsMandatory:Boolean? = null
    open var IsCardinality:Boolean? = null
    open var IsSystem:Boolean? = null
    open var IsAudit:Boolean? = null
    open var IsVisibleToRecipients:Boolean? = null
    open var IsSingleUse:Boolean? = null
    open var Email:Boolean? = null
    open var EmailDefault:Boolean? = null
    open var EmailTemplateId:UUID? = null
    open var EmailTemplateBody:String? = null
    open var EmailSubject:String? = null
    open var SMS:Boolean? = null
    open var SMSDefault:Boolean? = null
    open var SMSTemplateId:UUID? = null
    open var SMSTemplateBody:String? = null
    open var UpdateNotification:Boolean? = null
    open var UpdateNotificationDefault:Boolean? = null
    open var UpdateTemplateId:UUID? = null
    open var UpdateTemplateBody:String? = null
    open var UpdateSubject:String? = null
    open var Push:Boolean? = null
    open var PushDefault:Boolean? = null
    open var Phone:Boolean? = null
    open var PhoneDefault:Boolean? = null
    open var ContactIdOwner:UUID? = null
    open var RecordStatus:String? = null
    open var EmailTemplateDefinitionId:UUID? = null
    open var SMSTemplateDefinitionId:UUID? = null
    open var UpdateTemplateDefinitionId:UUID? = null
    open var Index:Int? = null
}

open class NotificationRole
{
    open var RoleId:UUID? = null
    open var RoleName:String? = null
}

Kotlin 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"}}}