| All Verbs | /api/connections/{ConnectionId}/cancel | ||
|---|---|---|---|
| All Verbs | /api/connections/{ConnectionId}/remove |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ConnectionId | path | Guid | Yes | Connection to be updated |
| ContactId | query | Guid | Yes | Id of the contact linked to the connection |
| ContactTypeId | query | Guid | Yes | Type of contact being connected with. For e.g. Real Person, Virtual Person etc. |
| RoleId | query | Guid | Yes | Role Id linked to the connection request |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
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/{ConnectionId}/cancel HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
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
}
}
}