| All Verbs | /api/connections/{ContactId}/to/{ToContactId} |
|---|
// @ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
export class ConnectContactsInRolesResponse
{
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<ConnectContactsInRolesResponse>) { (Object as any).assign(this, init); }
}
/** @description Connect two contacts in the specified roles */
// @Api(Description="Connect two contacts in the specified roles")
export class ConnectContactsInRoles
{
/** @description 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")
public ContactId: string;
/** @description 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")
public ToContactId: string;
/** @description 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")
public ContactTypeId: string;
/** @description List of roles to connect contacts in */
// @ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
public Roles: string[] = [];
/** @description 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")
public SendConnectionEmails: boolean;
public constructor(init?: Partial<ConnectContactsInRoles>) { (Object as any).assign(this, init); }
}
TypeScript ConnectContactsInRoles DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Roles:
[
00000000-0000-0000-0000-000000000000
],
SendConnectionEmails: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}