| All Verbs | /api/connections/{ConnectionId}/cancel | ||
|---|---|---|---|
| All Verbs | /api/connections/{ConnectionId}/remove |
"use strict";
export class ConnectionStatusUpdateResponse {
/** @param {{ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
}
export class ConnectionStatusUpdate {
/** @param {{ConnectionId?:string,ContactId?:string,ContactTypeId?:string,RoleId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Connection to be updated */
ConnectionId;
/**
* @type {string}
* @description Id of the contact linked to the connection */
ContactId;
/**
* @type {string}
* @description Type of contact being connected with. For e.g. Real Person, Virtual Person etc. */
ContactTypeId;
/**
* @type {string}
* @description Role Id linked to the connection request */
RoleId;
}
JavaScript ConnectionStatusUpdate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/connections/{ConnectionId}/cancel HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"ConnectionId":"00000000-0000-0000-0000-000000000000","ContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","RoleId":"00000000-0000-0000-0000-000000000000"}
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"}}}