Platform API

AddConnectionsInRole

Connect two contacts in the specified roles

The following routes are available for this service:
All Verbs	/api/connections/{ContactId}/role/{RoleId}

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.Causal.Common.Entity;

namespace Eros.Causal.Common.Entity
{
    public partial class GuidLookup
    {
        public virtual Guid LookupId { get; set; }
        public virtual Guid Value { get; set; }
    }

}

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 AddConnectionsInRole
    {
        ///<summary>
        ///Create a connection from this contact to the specified list of contacts in the specified role.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified list of contacts in the specified role.", IsRequired=true, Name="ContactId")]
        public virtual Guid ContactId { get; set; }

        ///<summary>
        ///List of contacts to add  to the role, including the type of contact
        ///</summary>
        [ApiMember(DataType="List<GuidLookup>", Description="List of contacts to add  to the role, including the type of contact", IsRequired=true, Name="ToContacts")]
        public virtual List<GuidLookup> ToContacts { get; set; } = [];

        ///<summary>
        ///Create a connection between contacts in the specified role.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Create a connection between contacts in the specified role.", IsRequired=true, Name="RoleId")]
        public virtual Guid RoleId { 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# AddConnectionsInRole DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/connections/{ContactId}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ToContacts: 
	[
		{
			
		}
	],
	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
		}
	}
}