| All Verbs | /api/connections/{ContactId}/to/{ToContactId} |
|---|
import Foundation
import ServiceStack
/**
* Connect two contacts in the specified roles
*/
// @Api(Description="Connect two contacts in the specified roles")
public class ConnectContactsInRoles : Codable
{
/**
* 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 var contactId:String
/**
* 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 var toContactId: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
/**
* List of roles to connect contacts in
*/
// @ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
public var roles:[String] = []
/**
* 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 var sendConnectionEmails:Bool
required public init(){}
}
// @ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
public class ConnectContactsInRolesResponse : Codable
{
public var responseStatus:ResponseStatus
required public init(){}
}
Swift ConnectContactsInRoles 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/{ContactId}/to/{ToContactId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","ToContactId":"00000000-0000-0000-0000-000000000000","ContactTypeId":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"SendConnectionEmails":false}
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"}}}