| All Verbs | /api/connections/{ContactId}/role/{RoleId} |
|---|
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 AddConnectionsInRole
{
/**
* 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 UUID ContactId = null;
/**
* 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 ArrayList<GuidLookup> ToContacts = new ArrayList<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 UUID RoleId = null;
/**
* 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 AddConnectionsInRole setContactId(UUID value) { this.ContactId = value; return this; }
public ArrayList<GuidLookup> getToContacts() { return ToContacts; }
public AddConnectionsInRole setToContacts(ArrayList<GuidLookup> value) { this.ToContacts = value; return this; }
public UUID getRoleId() { return RoleId; }
public AddConnectionsInRole setRoleId(UUID value) { this.RoleId = value; return this; }
public Boolean isSendConnectionEmails() { return SendConnectionEmails; }
public AddConnectionsInRole setSendConnectionEmails(Boolean value) { this.SendConnectionEmails = value; return this; }
}
public static class GuidLookup
{
public UUID LookupId = null;
public UUID Value = null;
public UUID getLookupId() { return LookupId; }
public GuidLookup setLookupId(UUID value) { this.LookupId = value; return this; }
public UUID getValue() { return Value; }
public GuidLookup setValue(UUID value) { this.Value = 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 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
}
}
}