| All Verbs | /api/contacts/{ContactId}/links |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Retrieve links to a contact (connections/roles/emailAddressBook
*/
@Api(Description="Retrieve links to a contact (connections/roles/emailAddressBook")
open class ContactConnectedLinks
{
open var ContactId:UUID? = null
}
open class ContactConnectedLinksResponse
{
/**
* A list of roles assigned to the contact/user.
*/
@ApiMember(DataType="List<UserRoleModel>", Description="A list of roles assigned to the contact/user.", Name="Roles", ParameterType="query")
open var Roles:ArrayList<UserRoleModel>? = null
/**
* A list of contact connections assigned to the contact/user.
*/
@ApiMember(DataType="List<UserContactConnectionModel>", Description="A list of contact connections assigned to the contact/user.", Name="ContactConnections", ParameterType="query")
open var ContactConnections:ArrayList<UserContactConnectionModel>? = null
/**
* 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")
open var EmailAddressBook:ArrayList<ContactEmailAddress>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class UserRoleModel
{
/**
* 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")
open var ContactRoleId:UUID? = null
/**
* The Role Id.
*/
@ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query")
open var RoleId:UUID? = null
/**
* The role name.
*/
@ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query")
open var RoleName:String? = null
/**
* The URL of the role's image icon.
*/
@ApiMember(DataType="string", Description="The URL of the role's image icon.", Name="RolePrimaryImageURL", ParameterType="query")
open var RolePrimaryImageURL:String? = null
/**
* The URL of the role's thumbnail image icon.
*/
@ApiMember(DataType="string", Description="The URL of the role's thumbnail image icon.", Name="RolePrimaryImageThumbnailURL", ParameterType="query")
open var RolePrimaryImageThumbnailURL:String? = null
/**
* The Guid of the role's media file containing the image icon details.
*/
@ApiMember(DataType="string", Description="The Guid of the role's media file containing the image icon details.", Name="RolePrimaryImageId", ParameterType="query")
open var RolePrimaryImageId:UUID? = null
/**
* The date the contact started having this role.
*/
@ApiMember(DataType="DateTime", Description="The date the contact started having this role.", Name="StartDate", ParameterType="query")
open var StartDate:Date? = null
/**
* The date the contact will end having this role.
*/
@ApiMember(DataType="DateTime?", Description="The date the contact will end having this role.", Name="EndDate", ParameterType="query")
open var EndDate:Date? = null
}
open class UserContactConnectionModel
{
/**
* 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")
open var ContactRoleId:UUID? = null
/**
* The role name.
*/
@ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")
open var ContactRoleName:String? = null
/**
* The list item role Id.
*/
@ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")
open var ContactListItemRoleId:UUID? = null
/**
* 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")
open var ContactRolePrimaryImageURL:String? = null
/**
* 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")
open var ContactRolePrimaryImageThumbnailURL:String? = null
/**
* 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")
open var ContactRolePrimaryImageId:UUID? = null
/**
* The connected contacts Id. (licensee)
*/
@ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")
open var ConnectionContactId:UUID? = null
/**
* The connected contacts Full Name.
*/
@ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")
open var ConnectionContactName:String? = null
/**
* The connected contacts role.
*/
@ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")
open var ConnectionContactRoleName:String? = null
/**
* The connected contacts role Id.
*/
@ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")
open var ConnectionContactRoleId:UUID? = null
/**
* The connected contacts list item role Id.
*/
@ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")
open var ConnectionContactListItemRoleId:UUID? = null
/**
* The Contacts Type.
*/
@ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")
open var ContactTypeName:String? = null
/**
* The URL to the Connected Contacts Photo.
*/
@ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")
open var ConnectionContactPhotoURL:String? = null
/**
* .
*/
@ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")
open var IsContactLicenseeRole:Boolean? = null
/**
* 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")
open var IsConnectionLicenseeRole:Boolean? = null
/**
* The status of the connection with the contact.
*/
@ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query")
open var ConnectionStatusName:String? = null
/**
* 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")
open var ConnectionStatusId:UUID? = null
/**
* 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")
open var ConnectionId:UUID? = null
/**
* 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")
open var ConnectionRequestId:UUID? = null
}
open class ContactEmailAddress
{
/**
* The Contact Id of the contact.
*/
@ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")
open var ContactId:UUID? = null
/**
* The Contact Full Name
*/
@ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query")
open var ContactName:String? = null
/**
* The Contact Email Address.
*/
@ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")
open var EmailAddress:String? = null
/**
* The Contact Photo URL
*/
@ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")
open var ContactPhotoURL:String? = null
}
Kotlin ContactConnectedLinks 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 /api/contacts/{ContactId}/links HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
{
RoleName: String,
RolePrimaryImageURL: String,
RolePrimaryImageThumbnailURL: String,
StartDate: 0001-01-01,
EndDate: 0001-01-01
}
],
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
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}