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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationItem:
    id: Optional[str] = None
    name: Optional[str] = None


# @Api(Description="Updates contact notifications")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateContactNotifications:
    """
    Updates contact notifications
    """

    # @ApiMember(Description="Id of contact to get notification for", IsRequired=true, Name="ContactId")
    contact_id: Optional[str] = None
    """
    Id of contact to get notification for
    """


    # @ApiMember(Description="Id of licensee to get notification for", IsRequired=true, Name="LicenseeId")
    licensee_id: Optional[str] = None
    """
    Id of licensee to get notification for
    """


    # @ApiMember(Description="Id of suite to get notification for", IsRequired=true, Name="SuiteId")
    suite_id: Optional[str] = None
    """
    Id of suite to get notification for
    """


    # @ApiMember(Description="List of notification to update", IsRequired=true, Name="Notifications")
    notifications: List[NotificationItem] = field(default_factory=list)
    """
    List of notification to update
    """

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