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
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
'''<Summary>
'''Returns a list of contacts connected to a user profiles' contact.
'''</Summary>
<Api(Description:="Returns a list of contacts connected to a user profiles' contact.")>
Public Partial Class GetConnectedContacts
'''<Summary>
'''The user's Guid. Contacts retrieved will be connected to this user.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="The user's Guid. Contacts retrieved will be connected to this user.", IsRequired:=true, Name:="UserId", ParameterType:="query")>
Public Overridable Property UserId As Guid
'''<Summary>
'''The user profiles Contact Guid. Contacts connected to the user will be filted by this profiles contact ID.
'''</Summary>
<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 Overridable Property ContactId As Guid
'''<Summary>
'''The suite id list. Gets contacts connected to the user filted by the suite IDs in this list..
'''</Summary>
<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 Overridable Property SuiteIds As List(Of Guid)
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 UserContacts
'''<Summary>
'''A list of contact connections assigned to the user.
'''</Summary>
<ApiMember(DataType:="List<UserContactConnectionModel>", Description:="A list of contact connections assigned to the 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)
End Class
End Namespace
End Namespace
VB.NET GetConnectedContacts 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 /xml/reply/GetConnectedContacts HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetConnectedContacts 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>
<SuiteIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</SuiteIds>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</GetConnectedContacts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<UserContacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ContactConnections>
<UserContactConnectionModel>
<ConnectionContactId>00000000-0000-0000-0000-000000000000</ConnectionContactId>
<ConnectionContactListItemRoleId>00000000-0000-0000-0000-000000000000</ConnectionContactListItemRoleId>
<ConnectionContactName>String</ConnectionContactName>
<ConnectionContactPhotoURL>String</ConnectionContactPhotoURL>
<ConnectionContactRoleId>00000000-0000-0000-0000-000000000000</ConnectionContactRoleId>
<ConnectionContactRoleName>String</ConnectionContactRoleName>
<ConnectionId>00000000-0000-0000-0000-000000000000</ConnectionId>
<ConnectionRequestId>00000000-0000-0000-0000-000000000000</ConnectionRequestId>
<ConnectionStatusId>00000000-0000-0000-0000-000000000000</ConnectionStatusId>
<ConnectionStatusName>String</ConnectionStatusName>
<ContactListItemRoleId>00000000-0000-0000-0000-000000000000</ContactListItemRoleId>
<ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
<ContactRoleName>String</ContactRoleName>
<ContactRolePrimaryImageId>00000000-0000-0000-0000-000000000000</ContactRolePrimaryImageId>
<ContactRolePrimaryImageThumbnailURL>String</ContactRolePrimaryImageThumbnailURL>
<ContactRolePrimaryImageURL>String</ContactRolePrimaryImageURL>
<ContactTypeName>String</ContactTypeName>
<IsConnectionLicenseeRole>false</IsConnectionLicenseeRole>
<IsContactLicenseeRole>false</IsContactLicenseeRole>
</UserContactConnectionModel>
</ContactConnections>
<EmailAddressBook>
<ContactEmailAddress>
<ContactId>00000000-0000-0000-0000-000000000000</ContactId>
<ContactName>String</ContactName>
<ContactPhotoURL>String</ContactPhotoURL>
<EmailAddress>String</EmailAddress>
</ContactEmailAddress>
</EmailAddressBook>
</UserContacts>