Platform API

UpdateContactNotifications

Updates contact notifications

The following routes are available for this service:
PUT	/api/contact/{ContactId}/updatenotifications

import Foundation
import ServiceStack

/**
* Updates contact notifications
*/
// @Api(Description="Updates contact notifications")
public class UpdateContactNotifications : Codable
{
    /**
    * Id of contact to get notification for
    */
    // @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
    public var contactId:String

    /**
    * Id of licensee to get notification for
    */
    // @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
    public var licenseeId:String

    /**
    * Id of suite to get notification for
    */
    // @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
    public var suiteId:String

    /**
    * List of notification to update
    */
    // @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
    public var notifications:[NotificationItem] = []

    required public init(){}
}

public class NotificationItem : Codable
{
    public var id:String
    public var name:String

    required public init(){}
}

Swift UpdateContactNotifications 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.

PUT /api/contact/{ContactId}/updatenotifications HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Notifications: 
	[
		{
			Name: String
		}
	]
}

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

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}