| All Verbs | /api/connections/{ContactId}/role/{RoleId} |
|---|
import Foundation
import ServiceStack
/**
* Connect two contacts in the specified roles
*/
// @Api(Description="Connect two contacts in the specified roles")
public class AddConnectionsInRole : Codable
{
/**
* Create a connection from this contact to the specified list of contacts in the specified role.
*/
// @ApiMember(DataType="Guid", Description="Create a connection from this contact to the specified list of contacts in the specified role.", IsRequired=true, Name="ContactId")
public var contactId:String
/**
* List of contacts to add to the role, including the type of contact
*/
// @ApiMember(DataType="List<GuidLookup>", Description="List of contacts to add to the role, including the type of contact", IsRequired=true, Name="ToContacts")
public var toContacts:[GuidLookup] = []
/**
* Create a connection between contacts in the specified role.
*/
// @ApiMember(DataType="Guid", Description="Create a connection between contacts in the specified role.", IsRequired=true, Name="RoleId")
public var roleId: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(){}
}
public class GuidLookup : Codable
{
public var lookupId:String
public var value:String
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 AddConnectionsInRole DTOs
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/{ContactId}/role/{RoleId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ToContacts:
[
{
}
],
SendConnectionEmails: False
}
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
}
}
}