Platform API

GetSuiteNotifications

Get notifications for the specified suite

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

import Foundation
import ServiceStack

/**
* Get notifications for the specified suite
*/
// @Api(Description="Get notifications for the specified suite")
public class GetSuiteNotifications : Codable
{
    /**
    * Id of suite to get notifications for
    */
    // @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="SuiteId")
    public var suiteId:String

    required public init(){}
}

// @ApiResponse(Description="List of suite notifications")
public class GetSuiteNotificationsResponse : Codable
{
    public var notifications:[Notification]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class Notification : Codable
{
    public var notificationId:String
    public var notificationGroupId:String
    public var notificationGroupName:String
    public var suiteId:String
    public var suiteName:String
    public var notificationValueId:String
    public var roles:[NotificationRole]
    public var rolesToDisplay:String
    public var name:String
    public var Description:String
    public var isMandatory:Bool
    public var isCardinality:Bool
    public var isSystem:Bool
    public var isAudit:Bool
    public var isVisibleToRecipients:Bool
    public var isSingleUse:Bool
    public var email:Bool
    public var emailDefault:Bool
    public var emailTemplateId:String
    public var emailTemplateBody:String
    public var emailSubject:String
    public var sms:Bool
    public var smsDefault:Bool
    public var smsTemplateId:String
    public var smsTemplateBody:String
    public var updateNotification:Bool
    public var updateNotificationDefault:Bool
    public var updateTemplateId:String
    public var updateTemplateBody:String
    public var updateSubject:String
    public var push:Bool
    public var pushDefault:Bool
    public var phone:Bool
    public var phoneDefault:Bool
    public var contactIdOwner:String
    public var recordStatus:String
    public var emailTemplateDefinitionId:String
    public var smsTemplateDefinitionId:String
    public var updateTemplateDefinitionId:String
    public var index:Int

    required public init(){}
}

public class NotificationRole : Codable
{
    public var roleId:String
    public var roleName:String

    required public init(){}
}

Swift 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
		}
	}
}