| All Verbs | /api/contact/{ContactId}/notifications |
|---|
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 InputSwitch:
id: Optional[str] = None
name: Optional[str] = None
is_disabled: bool = False
is_checked: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationDetails:
notification_id: Optional[str] = None
notification_group_name: Optional[str] = None
notification_value_id: Optional[str] = None
name: Optional[str] = None
description: Optional[str] = None
is_mandatory: bool = False
is_cardinality: bool = False
is_system: bool = False
is_visible_to_recipients: bool = False
index: int = 0
email: Optional[InputSwitch] = None
sms: Optional[InputSwitch] = None
update_notification: Optional[InputSwitch] = None
push: Optional[InputSwitch] = None
phone: Optional[InputSwitch] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotificationGroup:
group_name: Optional[str] = None
notifications: Optional[List[NotificationDetails]] = None
# @ApiResponse(Description="List of contact notifications")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactNotificationsResponse:
notifications: Optional[List[NotificationGroup]] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get notifications for the specified contact")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetContactNotifications:
"""
Get notifications for the specified contact
"""
# @ApiMember(Description="Id of contact to get notifications for", IsRequired=true, Name="ContactId")
contact_id: Optional[str] = None
"""
Id of contact to get notifications for
"""
# @ApiMember(Description="Id of licensee to get notifications for", IsRequired=true, Name="LicenseeId")
licensee_id: Optional[str] = None
"""
Id of licensee to get notifications for
"""
# @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="Suite")
suite_id: Optional[str] = None
"""
Id of suite to get notifications for
"""
Python GetContactNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contact/{ContactId}/notifications HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetContactNotifications xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<LicenseeId>00000000-0000-0000-0000-000000000000</LicenseeId>
<SuiteId>00000000-0000-0000-0000-000000000000</SuiteId>
</GetContactNotifications>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetContactNotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Notifications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
<d2p1:NotificationGroup>
<d2p1:GroupName>String</d2p1:GroupName>
<d2p1:Notifications>
<d2p1:NotificationDetails>
<d2p1:Description>String</d2p1:Description>
<d2p1:Email>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsChecked>false</d2p1:IsChecked>
<d2p1:IsDisabled>false</d2p1:IsDisabled>
<d2p1:Name>String</d2p1:Name>
</d2p1:Email>
<d2p1:Index>0</d2p1:Index>
<d2p1:IsCardinality>false</d2p1:IsCardinality>
<d2p1:IsMandatory>false</d2p1:IsMandatory>
<d2p1:IsSystem>false</d2p1:IsSystem>
<d2p1:IsVisibleToRecipients>false</d2p1:IsVisibleToRecipients>
<d2p1:Name>String</d2p1:Name>
<d2p1:NotificationGroupName>String</d2p1:NotificationGroupName>
<d2p1:NotificationId>00000000-0000-0000-0000-000000000000</d2p1:NotificationId>
<d2p1:NotificationValueId>00000000-0000-0000-0000-000000000000</d2p1:NotificationValueId>
<d2p1:Phone>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsChecked>false</d2p1:IsChecked>
<d2p1:IsDisabled>false</d2p1:IsDisabled>
<d2p1:Name>String</d2p1:Name>
</d2p1:Phone>
<d2p1:Push>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsChecked>false</d2p1:IsChecked>
<d2p1:IsDisabled>false</d2p1:IsDisabled>
<d2p1:Name>String</d2p1:Name>
</d2p1:Push>
<d2p1:SMS>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsChecked>false</d2p1:IsChecked>
<d2p1:IsDisabled>false</d2p1:IsDisabled>
<d2p1:Name>String</d2p1:Name>
</d2p1:SMS>
<d2p1:UpdateNotification>
<d2p1:Id>String</d2p1:Id>
<d2p1:IsChecked>false</d2p1:IsChecked>
<d2p1:IsDisabled>false</d2p1:IsDisabled>
<d2p1:Name>String</d2p1:Name>
</d2p1:UpdateNotification>
</d2p1:NotificationDetails>
</d2p1:Notifications>
</d2p1:NotificationGroup>
</Notifications>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetContactNotificationsResponse>