| All Verbs | /api/contacts/{ContactId}/connections |
|---|
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 ContactSummaryModel() =
///<summary>
///Contact linked to the profile
///</summary>
[<ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Full name of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")>]
member val ContactFullName:String = null with get,set
///<summary>
///Email Address of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")>]
member val EmailAddress:String = null with get,set
///<summary>
///Mobile Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")>]
member val MobileNumber:String = null with get,set
///<summary>
///Primary Phone Number of the contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")>]
member val PhoneNumber:String = null with get,set
///<summary>
///Type of contact (person, organisation etc.) linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Profile photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")>]
member val ProfilePhotoUrl:String = null with get,set
///<summary>
///Thumbnail photo of contact linked to the profile
///</summary>
[<ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")>]
member val ProfilePhotoThumbnailUrl:String = null with get,set
///<summary>
///Profile description
///</summary>
[<ApiMember(DataType="string", Description="Profile description", Name="Description")>]
member val Description:String = null with get,set
///<summary>
///Employment Industry
///</summary>
[<ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")>]
member val EmploymentIndustry:String = null with get,set
///<summary>
///Employment Role
///</summary>
[<ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")>]
member val EmploymentRole:String = null with get,set
///<summary>
///Areas of Work
///</summary>
[<ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")>]
member val EmploymentGeographicArea:String = null with get,set
///<summary>
///Timezone Name
///</summary>
[<ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")>]
member val TimezoneName:String = null with get,set
///<summary>
///The primary address of the contact
///</summary>
[<ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")>]
member val PrimaryAddress:String = null with get,set
///<summary>
///Have all connections to the contact been removed?
///</summary>
[<ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")>]
member val IsRemovedContact:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ContactConnectionModel() =
///<summary>
///Connection Id (if applicable)
///</summary>
[<ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")>]
member val ConnectionId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Connection Request Id (if applicable)
///</summary>
[<ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")>]
member val ConnectionRequestId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Details of the contact
///</summary>
[<ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")>]
member val Contact:ContactSummaryModel = null with get,set
///<summary>
///Contact's role Id in the connection
///</summary>
[<ApiMember(DataType="Guid", Description="Contact's role Id in the connection", IsRequired=true, Name="ContactRoleId")>]
member val ContactRoleId:Guid = new Guid() with get,set
///<summary>
///Contact's role name in the connection
///</summary>
[<ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")>]
member val ContactRoleName:String = null with get,set
///<summary>
///Requestor Contact Id
///</summary>
[<ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")>]
member val RequestorContactId:Guid = new Guid() with get,set
///<summary>
///Requestor Contact Name
///</summary>
[<ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")>]
member val RequestorContactName:String = null with get,set
///<summary>
///Requestor contact's role Id in the connection
///</summary>
[<ApiMember(DataType="Guid", Description="Requestor contact's role Id in the connection", IsRequired=true, Name="RequestorRoleId")>]
member val RequestorRoleId:Guid = new Guid() with get,set
///<summary>
///Requestor's role name in the connection
///</summary>
[<ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")>]
member val RequestorRoleName:String = null with get,set
///<summary>
///Primary role in the connection to display
///</summary>
[<ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")>]
member val PrimaryRoleName:String = null with get,set
///<summary>
///Connection Status Id
///</summary>
[<ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")>]
member val ConnectionStatusId:Guid = new Guid() with get,set
///<summary>
///Connection Status Name
///</summary>
[<ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")>]
member val ConnectionStatusName:String = null with get,set
///<summary>
///Is this a pending connection request?
///</summary>
[<ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")>]
member val IsConnectionRequest:Boolean = new Boolean() with get,set
///<summary>
///Is this an incoming connection request?
///</summary>
[<ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")>]
member val IsIncoming:Boolean = new Boolean() with get,set
member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Details of the contact suggesting this connection
///</summary>
[<ApiMember(DataType="ContactSummaryModel", Description="Details of the contact suggesting this connection", IsRequired=true, Name="SuggesterContact")>]
member val SuggesterContact:ContactSummaryModel = null with get,set
///<summary>
///Can this connection be cancelled?
///</summary>
[<ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")>]
member val AllowCancel:Boolean = new Boolean() with get,set
///<summary>
///Can this connection be removed?
///</summary>
[<ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")>]
member val AllowRemove:Boolean = new Boolean() with get,set
[<ApiResponse(Description="Connections to the specified contact for the requestor contact")>]
[<AllowNullLiteral>]
type GetConnectionsToContactResponse() =
member val Connections:ResizeArray<ContactConnectionModel> = null with get,set
member val TotalConnections:Int32 = new Int32() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type SortOrder =
| Ascending = 0
| Descending = 1
[<AllowNullLiteral>]
type PagedModel() =
///<summary>
///Page Number to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")>]
member val PageNumber:Int32 = new Int32() with get,set
///<summary>
///Number of records to retrieve
///</summary>
[<ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")>]
member val PageSize:Int32 = new Int32() with get,set
///<summary>
///Index of field to sort results by
///</summary>
[<ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")>]
member val SortIndex:Int32 = new Int32() with get,set
///<summary>
///Sort Order - Ascending or Descending
///</summary>
[<ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")>]
member val SortOrder:SortOrder = new SortOrder() with get,set
///<summary>
///Get connections to the specified contact for the requestor contact
///</summary>
[<Api(Description="Get connections to the specified contact for the requestor contact")>]
[<AllowNullLiteral>]
type GetConnectionsToContact() =
inherit PagedModel()
///<summary>
///Contact Id to get connections for
///</summary>
[<ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")>]
member val ContactId:Guid = new Guid() with get,set
///<summary>
///Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
///</summary>
[<ApiMember(DataType="Guid", Description="Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)", IsRequired=true, Name="ContactTypeId")>]
member val ContactTypeId:Guid = new Guid() with get,set
///<summary>
///Contact Id requesting the details - Current user or licensee
///</summary>
[<ApiMember(DataType="Guid", Description="Contact Id requesting the details - Current user or licensee", IsRequired=true, Name="RequestorContactId")>]
member val RequestorContactId:Guid = new Guid() with get,set
///<summary>
///Return all connections or paged results?
///</summary>
[<ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")>]
member val IsPagedMode:Boolean = new Boolean() with get,set
///<summary>
///Option to return removed connections
///</summary>
[<ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")>]
member val IncludeRemoved:Boolean = new Boolean() with get,set
F# GetConnectionsToContact DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{ContactId}/connections HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","RequestorContactId":"00000000-0000-0000-0000-000000000000","IsPagedMode":false,"IncludeRemoved":false,"PageNumber":0,"PageSize":0,"SortIndex":0,"SortOrder":"Ascending"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Connections":[{"ConnectionId":"00000000000000000000000000000000","ConnectionRequestId":"00000000000000000000000000000000","Contact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","RequestorContactId":"00000000-0000-0000-0000-000000000000","RequestorContactName":"String","RequestorRoleId":"00000000-0000-0000-0000-000000000000","RequestorRoleName":"String","PrimaryRoleName":"String","ConnectionStatusId":"00000000-0000-0000-0000-000000000000","ConnectionStatusName":"String","IsConnectionRequest":false,"IsIncoming":false,"FromDate":"0001-01-01T00:00:00.0000000","SuggesterContact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"AllowCancel":false,"AllowRemove":false}],"TotalConnections":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}