| All Verbs | /api/connections/{ConnectionId}/cancel | ||
|---|---|---|---|
| All Verbs | /api/connections/{ConnectionId}/remove |
import Foundation
import ServiceStack
/**
* Update the status of the specified connection
*/
// @Api(Description="Update the status of the specified connection")
public class ConnectionStatusUpdate : Codable
{
/**
* Connection to be updated
*/
// @ApiMember(Description="Connection to be updated", IsRequired=true, Name="ConnectionId")
public var connectionId:String
/**
* Id of the contact linked to the connection
*/
// @ApiMember(Description="Id of the contact linked to the connection", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* 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 var contactTypeId:String
/**
* Role Id linked to the connection request
*/
// @ApiMember(Description="Role Id linked to the connection request", IsRequired=true, Name="RoleId")
public var roleId:String
required public init(){}
}
public class ConnectionStatusUpdateResponse : Codable
{
public var responseStatus:ResponseStatus
required public init(){}
}
Swift ConnectionStatusUpdate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}