| All Verbs | /api/connections/{ConnectionId}/cancel | ||
|---|---|---|---|
| All Verbs | /api/connections/{ConnectionId}/remove |
export class ConnectionStatusUpdateResponse
{
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<ConnectionStatusUpdateResponse>) { (Object as any).assign(this, init); }
}
/** @description Update the status of the specified connection */
// @Api(Description="Update the status of the specified connection")
export class ConnectionStatusUpdate
{
/** @description Connection to be updated */
// @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
public ConnectionId: string;
/** @description Id of the contact linked to the connection */
// @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
public ContactId: 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 Role Id linked to the connection request */
// @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
public RoleId: string;
public constructor(init?: Partial<ConnectionStatusUpdate>) { (Object as any).assign(this, init); }
}
TypeScript ConnectionStatusUpdate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
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: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}