| All Verbs | /api/connections/{ContactId}/to/{ToContactId} |
|---|
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;
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
///<summary>
///Connect two contacts in the specified roles
///</summary>
[Api(Description="Connect two contacts in the specified roles")]
public partial class ConnectContactsInRoles
{
///<summary>
///Create a connection from this contact to the specified to contact in the specified roles.
///</summary>
[ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified to contact in the specified roles.", IsRequired=true, Name="ContactId")]
public virtual Guid ContactId { get; set; }
///<summary>
///Create a connection to this contact from the specified to contact in the specified roles.
///</summary>
[ApiMember(DataType="Guid", Description="Create a connection to this contact from the specified to contact in the specified roles.", IsRequired=true, Name="ToContactId")]
public virtual Guid ToContactId { get; set; }
///<summary>
///Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
///</summary>
[ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")]
public virtual Guid ContactTypeId { get; set; }
///<summary>
///List of roles to connect contacts in
///</summary>
[ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")]
public virtual List<Guid> Roles { get; set; } = [];
///<summary>
///Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance
///</summary>
[ApiMember(DataType="boolean", Description="Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance", IsRequired=true, Name="SendConnectionEmails")]
public virtual bool SendConnectionEmails { get; set; }
}
[ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")]
public partial class ConnectContactsInRolesResponse
{
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
C# ConnectContactsInRoles 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/connections/{ContactId}/to/{ToContactId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
00000000-0000-0000-0000-000000000000
],
SendConnectionEmails: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}