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}

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 AddConnectionsInRole
{
    /**
    * Create a connection from this contact to the specified list of contacts in the specified role.
    */
    @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified list of contacts in the specified role.", IsRequired=true, Name="ContactId")
    open var ContactId:UUID? = null

    /**
    * List of contacts to add  to the role, including the type of contact
    */
    @ApiMember(DataType="List<GuidLookup>", Description="List of contacts to add  to the role, including the type of contact", IsRequired=true, Name="ToContacts")
    open var ToContacts:ArrayList<GuidLookup> = ArrayList<GuidLookup>()

    /**
    * Create a connection between contacts in the specified role.
    */
    @ApiMember(DataType="Guid", Description="Create a connection between contacts in the specified role.", IsRequired=true, Name="RoleId")
    open var RoleId:UUID? = null

    /**
    * 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
}

open class GuidLookup
{
    open var LookupId:UUID? = null
    open var Value:UUID? = 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 AddConnectionsInRole 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}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ContactId":"00000000-0000-0000-0000-000000000000","ToContacts":[{"LookupId":"00000000-0000-0000-0000-000000000000","Value":"00000000-0000-0000-0000-000000000000"}],"RoleId":"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"}}}