Platform API

<back to all web services

UpdateContactNotifications

Updates contact notifications

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

export class NotificationItem
{
    public Id: string;
    public Name: string;

    public constructor(init?: Partial<NotificationItem>) { (Object as any).assign(this, init); }
}

/** @description Updates contact notifications */
// @Api(Description="Updates contact notifications")
export class UpdateContactNotifications
{
    /** @description Id of contact to get notification for */
    // @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
    public ContactId: string;

    /** @description Id of licensee to get notification for */
    // @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
    public LicenseeId: string;

    /** @description Id of suite to get notification for */
    // @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
    public SuiteId: string;

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

    public constructor(init?: Partial<UpdateContactNotifications>) { (Object as any).assign(this, init); }
}

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