| All Verbs | /api/contact/{ContactId}/notifications |
|---|
import Foundation
import ServiceStack
/**
* Get notifications for the specified contact
*/
// @Api(Description="Get notifications for the specified contact")
public class GetContactNotifications : Codable
{
/**
* Id of contact to get notifications for
*/
// @ApiMember(Description="Id of contact to get notifications for", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* Id of licensee to get notifications for
*/
// @ApiMember(Description="Id of licensee to get notifications for", IsRequired=true, Name="LicenseeId")
public var licenseeId:String
/**
* Id of suite to get notifications for
*/
// @ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="Suite")
public var suiteId:String
required public init(){}
}
// @ApiResponse(Description="List of contact notifications")
public class GetContactNotificationsResponse : Codable
{
public var notifications:[NotificationGroup]
public var responseStatus:ResponseStatus
required public init(){}
}
public class NotificationGroup : Codable
{
public var groupName:String
public var notifications:[NotificationDetails]
required public init(){}
}
public class NotificationDetails : Codable
{
public var notificationId:String
public var notificationGroupName:String
public var notificationValueId:String
public var name:String
public var Description:String
public var isMandatory:Bool
public var isCardinality:Bool
public var isSystem:Bool
public var isVisibleToRecipients:Bool
public var index:Int
public var email:InputSwitch
public var sms:InputSwitch
public var updateNotification:InputSwitch
public var push:InputSwitch
public var phone:InputSwitch
required public init(){}
}
public class InputSwitch : Codable
{
public var id:String
public var name:String
public var isDisabled:Bool
public var isChecked:Bool
required public init(){}
}
Swift 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>