import Foundation
import ServiceStack
/**
* Returns a list of licensee contacts connected to a user profile' contact.
*/
// @Api(Description="Returns a list of licensee contacts connected to a user profile' contact.")
public class GetLicenseeConnectedContacts : Codable
{
/**
* The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID.
*/
// @ApiMember(DataType="Guid", Description="The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID.", IsRequired=true, Name="ContactId", ParameterType="query")
public var contactId:String
/**
* The suite id list. Gets contacts connected to the user filted by the suite IDs in this list..
*/
// @ApiMember(DataType="List<Guid>", Description="The suite id list. Gets contacts connected to the user filted by the suite IDs in this list..", Name="SuiteIds", ParameterType="query")
public var suiteIds:[String]
required public init(){}
}
public class UserContacts : Codable
{
/**
* A list of contact connections assigned to the user.
*/
// @ApiMember(DataType="List<UserContactConnectionModel>", Description="A list of contact connections assigned to the user.", Name="ContactConnections", ParameterType="query")
public var contactConnections:[UserContactConnectionModel]
/**
* A list of connected contacts and their email addresses.
*/
// @ApiMember(DataType="List<ContactEmailAddressBook>", Description="A list of connected contacts and their email addresses.", Name="EmailAddressBook", ParameterType="query")
public var emailAddressBook:[ContactEmailAddress]
required public init(){}
}
public class UserContactConnectionModel : Codable
{
/**
* The Contact Role Id, that links the Contact to their role.
*/
// @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query")
public var contactRoleId:String
/**
* The role name.
*/
// @ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")
public var contactRoleName:String
/**
* The list item role Id.
*/
// @ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")
public var contactListItemRoleId:String
/**
* The URL of the contact role's image icon.
*/
// @ApiMember(DataType="string", Description="The URL of the contact role's image icon.", Name="ContactRolePrimaryImageURL", ParameterType="query")
public var contactRolePrimaryImageURL:String
/**
* The URL of the contact role's thumbnail image icon.
*/
// @ApiMember(DataType="string", Description="The URL of the contact role's thumbnail image icon.", Name="ContactRolePrimaryImageThumbnailURL", ParameterType="query")
public var contactRolePrimaryImageThumbnailURL:String
/**
* The Guid of the contact role's media file containing the image icon details.
*/
// @ApiMember(DataType="string", Description="The Guid of the contact role's media file containing the image icon details.", Name="ContactRolePrimaryImageId", ParameterType="query")
public var contactRolePrimaryImageId:String
/**
* The connected contacts Id. (licensee)
*/
// @ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")
public var connectionContactId:String
/**
* The connected contacts Full Name.
*/
// @ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")
public var connectionContactName:String
/**
* The connected contacts role.
*/
// @ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")
public var connectionContactRoleName:String
/**
* The connected contacts role Id.
*/
// @ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")
public var connectionContactRoleId:String
/**
* The connected contacts list item role Id.
*/
// @ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")
public var connectionContactListItemRoleId:String
/**
* The Contacts Type.
*/
// @ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")
public var contactTypeName:String
/**
* The URL to the Connected Contacts Photo.
*/
// @ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")
public var connectionContactPhotoURL:String
/**
* .
*/
// @ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")
public var isContactLicenseeRole:Bool
/**
* If the connection is as a licensee this is true.
*/
// @ApiMember(DataType="bool", Description="If the connection is as a licensee this is true.", Name="IsConnectionLicenseeRole", ParameterType="query")
public var isConnectionLicenseeRole:Bool
/**
* The status of the connection with the contact.
*/
// @ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")
public var connectionStatusName:String
/**
* The status Id of the connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The status Id of the connection with the contact.", Name="ConnectionStatusId", ParameterType="query")
public var connectionStatusId:String
/**
* The ContactRoleConnectionId of an active connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The ContactRoleConnectionId of an active connection with the contact.", Name="ConnectionId", ParameterType="query")
public var connectionId:String
/**
* The ContactRoleConnectionRequest of a pending connection with the contact.
*/
// @ApiMember(DataType="Guid", Description="The ContactRoleConnectionRequest of a pending connection with the contact.", Name="ConnectionRequestId", ParameterType="query")
public var connectionRequestId:String
required public init(){}
}
public class ContactEmailAddress : Codable
{
/**
* The Contact Id of the contact.
*/
// @ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")
public var contactId:String
/**
* The Contact Full Name
*/
// @ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query")
public var contactName:String
/**
* The Contact Email Address.
*/
// @ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")
public var emailAddress:String
/**
* The Contact Photo URL
*/
// @ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")
public var contactPhotoURL:String
required public init(){}
}
Swift GetLicenseeConnectedContacts DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/GetLicenseeConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SuiteIds:
[
00000000-0000-0000-0000-000000000000
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ContactConnections:
[
{
ContactRoleName: String,
ContactRolePrimaryImageURL: String,
ContactRolePrimaryImageThumbnailURL: String,
ConnectionContactName: String,
ConnectionContactRoleName: String,
ContactTypeName: String,
ConnectionContactPhotoURL: String,
IsContactLicenseeRole: False,
IsConnectionLicenseeRole: False,
ConnectionStatusName: String
}
],
EmailAddressBook:
[
{
ContactName: String,
EmailAddress: String,
ContactPhotoURL: String
}
]
}