| All Verbs | /api/contacts/{ContactId}/links |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Namespace Global
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
'''<Summary>
'''Retrieve links to a contact (connections/roles/emailAddressBook
'''</Summary>
<Api(Description:="Retrieve links to a contact (connections/roles/emailAddressBook")>
Public Partial Class ContactConnectedLinks
Public Overridable Property ContactId As Guid
End Class
Public Partial Class ContactConnectedLinksResponse
'''<Summary>
'''A list of roles assigned to the contact/user.
'''</Summary>
<ApiMember(DataType:="List<UserRoleModel>", Description:="A list of roles assigned to the contact/user.", Name:="Roles", ParameterType:="query")>
Public Overridable Property Roles As List(Of UserRoleModel)
'''<Summary>
'''A list of contact connections assigned to the contact/user.
'''</Summary>
<ApiMember(DataType:="List<UserContactConnectionModel>", Description:="A list of contact connections assigned to the contact/user.", Name:="ContactConnections", ParameterType:="query")>
Public Overridable Property ContactConnections As List(Of UserContactConnectionModel)
'''<Summary>
'''A list of connected contacts and their email addresses.
'''</Summary>
<ApiMember(DataType:="List<ContactEmailAddressBook>", Description:="A list of connected contacts and their email addresses.", Name:="EmailAddressBook", ParameterType:="query")>
Public Overridable Property EmailAddressBook As List(Of ContactEmailAddress)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class ContactEmailAddress
'''<Summary>
'''The Contact Id of the contact.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The Contact Id of the contact.", Name:="ContactId", ParameterType:="query")>
Public Overridable Property ContactId As Guid
'''<Summary>
'''The Contact Full Name
'''</Summary>
<ApiMember(DataType:="string", Description:="The Contact Full Name", Name:="ContactName", ParameterType:="query")>
Public Overridable Property ContactName As String
'''<Summary>
'''The Contact Email Address.
'''</Summary>
<ApiMember(DataType:="string", Description:="The Contact Email Address.", Name:="EmailAddress", ParameterType:="query")>
Public Overridable Property EmailAddress As String
'''<Summary>
'''The Contact Photo URL
'''</Summary>
<ApiMember(DataType:="string", Description:="The Contact Photo URL", Name:="ContactPhotoURL", ParameterType:="query")>
Public Overridable Property ContactPhotoURL As String
End Class
Public Partial Class UserContactConnectionModel
'''<Summary>
'''The Contact Role Id, that links the Contact to their role.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The Contact Role Id, that links the Contact to their role.", Name:="ContactRoleId", ParameterType:="query")>
Public Overridable Property ContactRoleId As Guid
'''<Summary>
'''The role name.
'''</Summary>
<ApiMember(DataType:="string", Description:="The role name.", Name:="ContactRoleName", ParameterType:="query")>
Public Overridable Property ContactRoleName As String
'''<Summary>
'''The list item role Id.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The list item role Id.", Name:="ContactListItemRoleId", ParameterType:="query")>
Public Overridable Property ContactListItemRoleId As Guid
'''<Summary>
'''The URL of the contact role's image icon.
'''</Summary>
<ApiMember(DataType:="string", Description:="The URL of the contact role's image icon.", Name:="ContactRolePrimaryImageURL", ParameterType:="query")>
Public Overridable Property ContactRolePrimaryImageURL As String
'''<Summary>
'''The URL of the contact role's thumbnail image icon.
'''</Summary>
<ApiMember(DataType:="string", Description:="The URL of the contact role's thumbnail image icon.", Name:="ContactRolePrimaryImageThumbnailURL", ParameterType:="query")>
Public Overridable Property ContactRolePrimaryImageThumbnailURL As String
'''<Summary>
'''The Guid of the contact role's media file containing the image icon details.
'''</Summary>
<ApiMember(DataType:="string", Description:="The Guid of the contact role's media file containing the image icon details.", Name:="ContactRolePrimaryImageId", ParameterType:="query")>
Public Overridable Property ContactRolePrimaryImageId As Guid
'''<Summary>
'''The connected contacts Id. (licensee)
'''</Summary>
<ApiMember(DataType:="string", Description:="The connected contacts Id. (licensee)", Name:="ConnectionContactId", ParameterType:="query")>
Public Overridable Property ConnectionContactId As Guid
'''<Summary>
'''The connected contacts Full Name.
'''</Summary>
<ApiMember(DataType:="string", Description:="The connected contacts Full Name.", Name:="ConnectionContactName", ParameterType:="query")>
Public Overridable Property ConnectionContactName As String
'''<Summary>
'''The connected contacts role.
'''</Summary>
<ApiMember(DataType:="string", Description:="The connected contacts role.", Name:="ConnectionContactRoleName", ParameterType:="query")>
Public Overridable Property ConnectionContactRoleName As String
'''<Summary>
'''The connected contacts role Id.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The connected contacts role Id.", Name:="ConnectionContactRoleId", ParameterType:="query")>
Public Overridable Property ConnectionContactRoleId As Guid
'''<Summary>
'''The connected contacts list item role Id.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The connected contacts list item role Id.", Name:="ConnectionContactListItemRoleId", ParameterType:="query")>
Public Overridable Property ConnectionContactListItemRoleId As Guid
'''<Summary>
'''The Contacts Type.
'''</Summary>
<ApiMember(DataType:="string", Description:="The Contacts Type.", Name:="ContactTypeName", ParameterType:="query")>
Public Overridable Property ContactTypeName As String
'''<Summary>
'''The URL to the Connected Contacts Photo.
'''</Summary>
<ApiMember(DataType:="string", Description:="The URL to the Connected Contacts Photo.", Name:="ConnectionContactPhotoURL", ParameterType:="query")>
Public Overridable Property ConnectionContactPhotoURL As String
'''<Summary>
'''.
'''</Summary>
<ApiMember(DataType:="bool", Description:=".", Name:="IsContactLicenseeRole", ParameterType:="query")>
Public Overridable Property IsContactLicenseeRole As Boolean
'''<Summary>
'''If the connection is as a licensee this is true.
'''</Summary>
<ApiMember(DataType:="bool", Description:="If the connection is as a licensee this is true.", Name:="IsConnectionLicenseeRole", ParameterType:="query")>
Public Overridable Property IsConnectionLicenseeRole As Boolean
'''<Summary>
'''The status of the connection with the contact.
'''</Summary>
<ApiMember(DataType:="string", Description:="The status of the connection with the contact.", Name:="ConnectionStatusName", ParameterType:="query")>
Public Overridable Property ConnectionStatusName As String
'''<Summary>
'''The status Id of the connection with the contact.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The status Id of the connection with the contact.", Name:="ConnectionStatusId", ParameterType:="query")>
Public Overridable Property ConnectionStatusId As Guid
'''<Summary>
'''The ContactRoleConnectionId of an active connection with the contact.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The ContactRoleConnectionId of an active connection with the contact.", Name:="ConnectionId", ParameterType:="query")>
Public Overridable Property ConnectionId As Guid
'''<Summary>
'''The ContactRoleConnectionRequest of a pending connection with the contact.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The ContactRoleConnectionRequest of a pending connection with the contact.", Name:="ConnectionRequestId", ParameterType:="query")>
Public Overridable Property ConnectionRequestId As Guid
End Class
Public Partial Class UserRoleModel
'''<Summary>
'''The Contact Role Id, that links the Contact to their role.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The Contact Role Id, that links the Contact to their role.", Name:="ContactRoleId", ParameterType:="query")>
Public Overridable Property ContactRoleId As Guid
'''<Summary>
'''The Role Id.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The Role Id.", Name:="RoleId", ParameterType:="query")>
Public Overridable Property RoleId As Guid
'''<Summary>
'''The role name.
'''</Summary>
<ApiMember(DataType:="string", Description:="The role name.", Name:="RoleName", ParameterType:="query")>
Public Overridable Property RoleName As String
'''<Summary>
'''The URL of the role's image icon.
'''</Summary>
<ApiMember(DataType:="string", Description:="The URL of the role's image icon.", Name:="RolePrimaryImageURL", ParameterType:="query")>
Public Overridable Property RolePrimaryImageURL As String
'''<Summary>
'''The URL of the role's thumbnail image icon.
'''</Summary>
<ApiMember(DataType:="string", Description:="The URL of the role's thumbnail image icon.", Name:="RolePrimaryImageThumbnailURL", ParameterType:="query")>
Public Overridable Property RolePrimaryImageThumbnailURL As String
'''<Summary>
'''The Guid of the role's media file containing the image icon details.
'''</Summary>
<ApiMember(DataType:="string", Description:="The Guid of the role's media file containing the image icon details.", Name:="RolePrimaryImageId", ParameterType:="query")>
Public Overridable Property RolePrimaryImageId As Guid
'''<Summary>
'''The date the contact started having this role.
'''</Summary>
<ApiMember(DataType:="DateTime", Description:="The date the contact started having this role.", Name:="StartDate", ParameterType:="query")>
Public Overridable Property StartDate As Date
'''<Summary>
'''The date the contact will end having this role.
'''</Summary>
<ApiMember(DataType:="DateTime?", Description:="The date the contact will end having this role.", Name:="EndDate", ParameterType:="query")>
Public Overridable Property EndDate As Date?
End Class
End Namespace
End Namespace
VB.NET 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
}
}
}