| All Verbs | /api/contacts/{ContactId}/links |
|---|
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type 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")>]
member val ContactRoleId:Guid = new Guid() with get,set
///<summary>
///The Role Id.
///</summary>
[<ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query")>]
member val RoleId:Guid = new Guid() with get,set
///<summary>
///The role name.
///</summary>
[<ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query")>]
member val RoleName:String = null with get,set
///<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")>]
member val RolePrimaryImageURL:String = null with get,set
///<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")>]
member val RolePrimaryImageThumbnailURL:String = null with get,set
///<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")>]
member val RolePrimaryImageId:Guid = new Guid() with get,set
///<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")>]
member val StartDate:DateTime = new DateTime() with get,set
///<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")>]
member val EndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type 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")>]
member val ContactRoleId:Guid = new Guid() with get,set
///<summary>
///The role name.
///</summary>
[<ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query")>]
member val ContactRoleName:String = null with get,set
///<summary>
///The list item role Id.
///</summary>
[<ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query")>]
member val ContactListItemRoleId:Guid = new Guid() with get,set
///<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")>]
member val ContactRolePrimaryImageURL:String = null with get,set
///<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")>]
member val ContactRolePrimaryImageThumbnailURL:String = null with get,set
///<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")>]
member val ContactRolePrimaryImageId:Guid = new Guid() with get,set
///<summary>
///The connected contacts Id. (licensee)
///</summary>
[<ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query")>]
member val ConnectionContactId:Guid = new Guid() with get,set
///<summary>
///The connected contacts Full Name.
///</summary>
[<ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query")>]
member val ConnectionContactName:String = null with get,set
///<summary>
///The connected contacts role.
///</summary>
[<ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query")>]
member val ConnectionContactRoleName:String = null with get,set
///<summary>
///The connected contacts role Id.
///</summary>
[<ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query")>]
member val ConnectionContactRoleId:Guid = new Guid() with get,set
///<summary>
///The connected contacts list item role Id.
///</summary>
[<ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query")>]
member val ConnectionContactListItemRoleId:Guid = new Guid() with get,set
///<summary>
///The Contacts Type.
///</summary>
[<ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query")>]
member val ContactTypeName:String = null with get,set
///<summary>
///The URL to the Connected Contacts Photo.
///</summary>
[<ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query")>]
member val ConnectionContactPhotoURL:String = null with get,set
///<summary>
///.
///</summary>
[<ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query")>]
member val IsContactLicenseeRole:Boolean = new Boolean() with get,set
///<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")>]
member val IsConnectionLicenseeRole:Boolean = new Boolean() with get,set
///<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")>]
member val ConnectionStatusName:String = null with get,set
///<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")>]
member val ConnectionStatusId:Guid = new Guid() with get,set
///<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")>]
member val ConnectionId:Guid = new Guid() with get,set
///<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")>]
member val ConnectionRequestId:Guid = new Guid() with get,set
[<AllowNullLiteral>]
type ContactEmailAddress() =
///<summary>
///The Contact Id of the contact.
///</summary>
[<ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///The Contact Full Name
///</summary>
[<ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query")>]
member val ContactName:String = null with get,set
///<summary>
///The Contact Email Address.
///</summary>
[<ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query")>]
member val EmailAddress:String = null with get,set
///<summary>
///The Contact Photo URL
///</summary>
[<ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query")>]
member val ContactPhotoURL:String = null with get,set
[<AllowNullLiteral>]
type 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")>]
member val Roles:ResizeArray<UserRoleModel> = null with get,set
///<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")>]
member val ContactConnections:ResizeArray<UserContactConnectionModel> = null with get,set
///<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")>]
member val EmailAddressBook:ResizeArray<ContactEmailAddress> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Retrieve links to a contact (connections/roles/emailAddressBook
///</summary>
[<Api(Description="Retrieve links to a contact (connections/roles/emailAddressBook")>]
[<AllowNullLiteral>]
type ContactConnectedLinks() =
member val ContactId:Guid = new Guid() with get,set
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/contacts/{ContactId}/links HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ContactConnectedLinks 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>
</ContactConnectedLinks>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ContactConnectedLinksResponse 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>
<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>
<Roles>
<UserRoleModel>
<ContactRoleId>00000000-0000-0000-0000-000000000000</ContactRoleId>
<EndDate>0001-01-01T00:00:00</EndDate>
<RoleId>00000000-0000-0000-0000-000000000000</RoleId>
<RoleName>String</RoleName>
<RolePrimaryImageId>00000000-0000-0000-0000-000000000000</RolePrimaryImageId>
<RolePrimaryImageThumbnailURL>String</RolePrimaryImageThumbnailURL>
<RolePrimaryImageURL>String</RolePrimaryImageURL>
<StartDate>0001-01-01T00:00:00</StartDate>
</UserRoleModel>
</Roles>
</ContactConnectedLinksResponse>