Platform API

<back to all web services

ConnectContactsInRoles

Connect two contacts in the specified roles

Requires Authentication
The following routes are available for this service:
All Verbs/api/connections/{ContactId}/to/{ToContactId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    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 Overridable Property ContactId As Guid

            '''<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 Overridable Property ToContactId As Guid

            '''<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 Overridable Property ContactTypeId As Guid

            '''<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 Overridable Property Roles As List(Of Guid) = New List(Of Guid)

            '''<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 Overridable Property SendConnectionEmails As Boolean
        End Class

        <ApiResponse(Description:="List of roles available for connection from the specified contact for specified contact types")>
        Public Partial Class ConnectContactsInRolesResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ConnectContactsInRoles DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ConnectContactsInRoles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ContactId>00000000-0000-0000-0000-000000000000</ContactId>
  <ContactTypeId>00000000-0000-0000-0000-000000000000</ContactTypeId>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </Roles>
  <SendConnectionEmails>false</SendConnectionEmails>
  <ToContactId>00000000-0000-0000-0000-000000000000</ToContactId>
</ConnectContactsInRoles>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConnectContactsInRolesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ConnectContactsInRolesResponse>