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}

"use strict";
export class ConnectContactsInRolesResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GuidLookup {
    /** @param {{LookupId?:string,Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LookupId;
    /** @type {string} */
    Value;
}
export class AddConnectionsInRole {
    /** @param {{ContactId?:string,ToContacts?:GuidLookup[],RoleId?:string,SendConnectionEmails?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Create a connection from this contact to the specified list of contacts in the specified role. */
    ContactId;
    /**
     * @type {GuidLookup[]}
     * @description List of contacts to add  to the role, including the type of contact */
    ToContacts = [];
    /**
     * @type {string}
     * @description Create a connection between contacts in the specified role. */
    RoleId;
    /**
     * @type {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 */
    SendConnectionEmails;
}

JavaScript AddConnectionsInRole 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}/role/{RoleId} HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddConnectionsInRole 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>
  <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
  <SendConnectionEmails>false</SendConnectionEmails>
  <ToContacts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Causal.Common.Entity">
    <d2p1:GuidLookup>
      <d2p1:LookupId>00000000-0000-0000-0000-000000000000</d2p1:LookupId>
      <d2p1:Value>00000000-0000-0000-0000-000000000000</d2p1:Value>
    </d2p1:GuidLookup>
  </ToContacts>
</AddConnectionsInRole>

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>