Platform API

ConnectContactsInRoles

Connect two contacts in the specified roles

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

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

    [<ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")>]
    [<AllowNullLiteral>]
    type ConnectContactsInRolesResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Connect two contacts in the specified roles
    ///</summary>
    [<Api(Description="Connect two contacts in the specified roles")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ContactId:Guid = new Guid() with 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")>]
        member val ToContactId:Guid = new Guid() with 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")>]
        member val ContactTypeId:Guid = new Guid() with 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")>]
        member val Roles:ResizeArray<Guid> = null with 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")>]
        member val SendConnectionEmails:Boolean = new Boolean() with get,set

F# ConnectContactsInRoles DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ToContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"SendConnectionEmails":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}