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}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Connect two contacts in the specified roles
*/
@Api(Description="Connect two contacts in the specified roles")
open class ConnectContactsInRoles
{
    /**
    * Create a connection from this contact to the specified to contact in the specified roles.
    */
    @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified to contact in the specified roles.", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * Create a connection to this contact from the specified to contact in the specified roles.
    */
    @ApiMember(DataType="Guid", Description="Create a connection to this contact from the specified to contact in the specified roles.", IsRequired=true, Name="ToContactId")
    open var ToContactId:UUID? = null

    /**
    * Type of contact being connected with. For e.g. Real Person, Virtual Person etc.
    */
    @ApiMember(DataType="Guid", Description="Type of contact being connected with. For e.g. Real Person, Virtual Person etc.", IsRequired=true, Name="ContactTypeId")
    open var ContactTypeId:UUID? = null

    /**
    * List of roles to connect contacts in
    */
    @ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
    open var Roles:ArrayList<UUID> = ArrayList<UUID>()

    /**
    * Send connection emails for auto - accept roles that are being assigned? Note: emails will always be sent if the role requires user acceptance
    */
    @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")
    open var SendConnectionEmails:Boolean? = null
}

@ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
open class ConnectContactsInRolesResponse
{
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin 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>