| All Verbs | /api/contacts/{ContactId}/connections |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;
using Eros.Saguna.Common.WebAPIModel.Models;
namespace Eros.Saguna.Common.WebAPIModel.Models
{
public partial class ContactConnectionModel
{
///<summary>
///Connection Id (if applicable)
///</summary>
[ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")]
public virtual Guid? ConnectionId { get; set; }
///<summary>
///Connection Request Id (if applicable)
///</summary>
[ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")]
public virtual Guid? ConnectionRequestId { get; set; }
///<summary>
///Details of the contact
///</summary>
[ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")]
public virtual ContactSummaryModel Contact { 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")]
public virtual Guid ContactRoleId { get; set; }
///<summary>
///Contact's role name in the connection
///</summary>
[ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")]
public virtual string ContactRoleName { get; set; }
///<summary>
///Requestor Contact Id
///</summary>
[ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")]
public virtual Guid RequestorContactId { get; set; }
///<summary>
///Requestor Contact Name
///</summary>
[ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")]
public virtual string RequestorContactName { 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")]
public virtual Guid RequestorRoleId { get; set; }
///<summary>
///Requestor's role name in the connection
///</summary>
[ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")]
public virtual string RequestorRoleName { get; set; }
///<summary>
///Primary role in the connection to display
///</summary>
[ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")]
public virtual string PrimaryRoleName { get; set; }
///<summary>
///Connection Status Id
///</summary>
[ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")]
public virtual Guid ConnectionStatusId { get; set; }
///<summary>
///Connection Status Name
///</summary>
[ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")]
public virtual string ConnectionStatusName { get; set; }
///<summary>
///Is this a pending connection request?
///</summary>
[ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")]
public virtual bool IsConnectionRequest { get; set; }
///<summary>
///Is this an incoming connection request?
///</summary>
[ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")]
public virtual bool IsIncoming { get; set; }
public virtual DateTime? FromDate { 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")]
public virtual ContactSummaryModel SuggesterContact { get; set; }
///<summary>
///Can this connection be cancelled?
///</summary>
[ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")]
public virtual bool AllowCancel { get; set; }
///<summary>
///Can this connection be removed?
///</summary>
[ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")]
public virtual bool AllowRemove { get; set; }
}
public partial class ContactSummaryModel
{
///<summary>
///Contact linked to the profile
///</summary>
[ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")]
public virtual Guid ContactId { 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")]
public virtual string ContactFullName { 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")]
public virtual string EmailAddress { 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")]
public virtual string MobileNumber { 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")]
public virtual string PhoneNumber { 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")]
public virtual Guid ContactTypeId { 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")]
public virtual string ProfilePhotoUrl { 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")]
public virtual string ProfilePhotoThumbnailUrl { get; set; }
///<summary>
///Profile description
///</summary>
[ApiMember(DataType="string", Description="Profile description", Name="Description")]
public virtual string Description { get; set; }
///<summary>
///Employment Industry
///</summary>
[ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")]
public virtual string EmploymentIndustry { get; set; }
///<summary>
///Employment Role
///</summary>
[ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")]
public virtual string EmploymentRole { get; set; }
///<summary>
///Areas of Work
///</summary>
[ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")]
public virtual string EmploymentGeographicArea { get; set; }
///<summary>
///Timezone Name
///</summary>
[ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")]
public virtual string TimezoneName { get; set; }
///<summary>
///The primary address of the contact
///</summary>
[ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")]
public virtual string PrimaryAddress { 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")]
public virtual bool IsRemovedContact { get; set; }
}
public partial class PagedModel
{
///<summary>
///Page Number to retrieve
///</summary>
[ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")]
public virtual int PageNumber { get; set; }
///<summary>
///Number of records to retrieve
///</summary>
[ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")]
public virtual int PageSize { get; set; }
///<summary>
///Index of field to sort results by
///</summary>
[ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")]
public virtual int SortIndex { get; set; }
///<summary>
///Sort Order - Ascending or Descending
///</summary>
[ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")]
public virtual SortOrder SortOrder { get; set; }
}
public enum SortOrder
{
Ascending,
Descending,
}
}
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Get connections to the specified contact for the requestor contact
///</summary>
[Api(Description="Get connections to the specified contact for the requestor contact")]
public partial class GetConnectionsToContact
: PagedModel
{
///<summary>
///Contact Id to get connections for
///</summary>
[ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")]
public virtual Guid ContactId { 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")]
public virtual Guid ContactTypeId { 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")]
public virtual Guid RequestorContactId { get; set; }
///<summary>
///Return all connections or paged results?
///</summary>
[ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")]
public virtual bool IsPagedMode { get; set; }
///<summary>
///Option to return removed connections
///</summary>
[ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")]
public virtual bool IncludeRemoved { get; set; }
}
[ApiResponse(Description="Connections to the specified contact for the requestor contact")]
public partial class GetConnectionsToContactResponse
{
public virtual List<ContactConnectionModel> Connections { get; set; }
public virtual int TotalConnections { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# GetConnectionsToContact DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
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"}}}