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 .other suffix or ?format=other

HTTP + OTHER

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

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