| All Verbs | /api/connections/{ContactId}/to/{ToContactId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Connect two contacts in the specified roles
*/
@Api(Description="Connect two contacts in the specified roles")
public static class ConnectContactsInRoles
{
/**
* 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 UUID ContactId = null;
/**
* 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 UUID ToContactId = null;
/**
* 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 UUID ContactTypeId = null;
/**
* List of roles to connect contacts in
*/
@ApiMember(DataType="List<Guid>", Description="List of roles to connect contacts in", IsRequired=true, Name="Roles")
public ArrayList<UUID> Roles = new ArrayList<UUID>();
/**
* 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 Boolean SendConnectionEmails = null;
public UUID getContactId() { return ContactId; }
public ConnectContactsInRoles setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getToContactId() { return ToContactId; }
public ConnectContactsInRoles setToContactId(UUID value) { this.ToContactId = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public ConnectContactsInRoles setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
public ArrayList<UUID> getRoles() { return Roles; }
public ConnectContactsInRoles setRoles(ArrayList<UUID> value) { this.Roles = value; return this; }
public Boolean isSendConnectionEmails() { return SendConnectionEmails; }
public ConnectContactsInRoles setSendConnectionEmails(Boolean value) { this.SendConnectionEmails = value; return this; }
}
@ApiResponse(Description="List of roles available for connection from the specified contact for specified contact types")
public static class ConnectContactsInRolesResponse
{
public ResponseStatus ResponseStatus = null;
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ConnectContactsInRolesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
Java 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"}}}