| All Verbs | /api/contact/{ContactId}/notifications |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get notifications for the specified contact
*/
@Api(Description="Get notifications for the specified contact")
public static class GetContactNotifications
{
/**
* Id of contact to get notifications for
*/
@ApiMember(Description="Id of contact to get notifications for", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* Id of licensee to get notifications for
*/
@ApiMember(Description="Id of licensee to get notifications for", IsRequired=true, Name="LicenseeId")
public UUID LicenseeId = null;
/**
* Id of suite to get notifications for
*/
@ApiMember(Description="Id of suite to get notifications for", IsRequired=true, Name="Suite")
public UUID SuiteId = null;
public UUID getContactId() { return ContactId; }
public GetContactNotifications setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getLicenseeId() { return LicenseeId; }
public GetContactNotifications setLicenseeId(UUID value) { this.LicenseeId = value; return this; }
public UUID getSuiteId() { return SuiteId; }
public GetContactNotifications setSuiteId(UUID value) { this.SuiteId = value; return this; }
}
@ApiResponse(Description="List of contact notifications")
public static class GetContactNotificationsResponse
{
public ArrayList<NotificationGroup> Notifications = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<NotificationGroup> getNotifications() { return Notifications; }
public GetContactNotificationsResponse setNotifications(ArrayList<NotificationGroup> value) { this.Notifications = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetContactNotificationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class NotificationGroup
{
public String GroupName = null;
public ArrayList<NotificationDetails> Notifications = null;
public String getGroupName() { return GroupName; }
public NotificationGroup setGroupName(String value) { this.GroupName = value; return this; }
public ArrayList<NotificationDetails> getNotifications() { return Notifications; }
public NotificationGroup setNotifications(ArrayList<NotificationDetails> value) { this.Notifications = value; return this; }
}
public static class NotificationDetails
{
public UUID NotificationId = null;
public String NotificationGroupName = null;
public UUID NotificationValueId = null;
public String Name = null;
public String Description = null;
public Boolean IsMandatory = null;
public Boolean IsCardinality = null;
public Boolean IsSystem = null;
public Boolean IsVisibleToRecipients = null;
public Integer Index = null;
public InputSwitch Email = null;
public InputSwitch SMS = null;
public InputSwitch UpdateNotification = null;
public InputSwitch Push = null;
public InputSwitch Phone = null;
public UUID getNotificationId() { return NotificationId; }
public NotificationDetails setNotificationId(UUID value) { this.NotificationId = value; return this; }
public String getNotificationGroupName() { return NotificationGroupName; }
public NotificationDetails setNotificationGroupName(String value) { this.NotificationGroupName = value; return this; }
public UUID getNotificationValueId() { return NotificationValueId; }
public NotificationDetails setNotificationValueId(UUID value) { this.NotificationValueId = value; return this; }
public String getName() { return Name; }
public NotificationDetails setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public NotificationDetails setDescription(String value) { this.Description = value; return this; }
public Boolean getIsMandatory() { return IsMandatory; }
public NotificationDetails setIsMandatory(Boolean value) { this.IsMandatory = value; return this; }
public Boolean getIsCardinality() { return IsCardinality; }
public NotificationDetails setIsCardinality(Boolean value) { this.IsCardinality = value; return this; }
public Boolean getIsSystem() { return IsSystem; }
public NotificationDetails setIsSystem(Boolean value) { this.IsSystem = value; return this; }
public Boolean getIsVisibleToRecipients() { return IsVisibleToRecipients; }
public NotificationDetails setIsVisibleToRecipients(Boolean value) { this.IsVisibleToRecipients = value; return this; }
public Integer getIndex() { return Index; }
public NotificationDetails setIndex(Integer value) { this.Index = value; return this; }
public InputSwitch getEmail() { return Email; }
public NotificationDetails setEmail(InputSwitch value) { this.Email = value; return this; }
public InputSwitch getSms() { return SMS; }
public NotificationDetails setSms(InputSwitch value) { this.SMS = value; return this; }
public InputSwitch getUpdateNotification() { return UpdateNotification; }
public NotificationDetails setUpdateNotification(InputSwitch value) { this.UpdateNotification = value; return this; }
public InputSwitch getPush() { return Push; }
public NotificationDetails setPush(InputSwitch value) { this.Push = value; return this; }
public InputSwitch getPhone() { return Phone; }
public NotificationDetails setPhone(InputSwitch value) { this.Phone = value; return this; }
}
public static class InputSwitch
{
public String Id = null;
public String Name = null;
public Boolean IsDisabled = null;
public Boolean IsChecked = null;
public String getId() { return Id; }
public InputSwitch setId(String value) { this.Id = value; return this; }
public String getName() { return Name; }
public InputSwitch setName(String value) { this.Name = value; return this; }
public Boolean getIsDisabled() { return IsDisabled; }
public InputSwitch setIsDisabled(Boolean value) { this.IsDisabled = value; return this; }
public Boolean getIsChecked() { return IsChecked; }
public InputSwitch setIsChecked(Boolean value) { this.IsChecked = value; return this; }
}
}
Java 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>