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 .jsv suffix or ?format=jsv

HTTP + JSV

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

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Notifications: 
	[
		{
			NotificationGroupName: String,
			SuiteName: String,
			Roles: 
			[
				{
					RoleName: String
				}
			],
			RolesToDisplay: String,
			Name: String,
			Description: String,
			IsMandatory: False,
			IsCardinality: False,
			IsSystem: False,
			IsAudit: False,
			IsVisibleToRecipients: False,
			IsSingleUse: False,
			Email: False,
			EmailDefault: False,
			EmailTemplateBody: String,
			EmailSubject: String,
			SMS: False,
			SMSDefault: False,
			SMSTemplateBody: String,
			UpdateNotification: False,
			UpdateNotificationDefault: False,
			UpdateTemplateBody: String,
			UpdateSubject: String,
			Push: False,
			PushDefault: False,
			Phone: False,
			PhoneDefault: False,
			RecordStatus: String,
			Index: 0
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}