| All Verbs | /api/contacts/{ContactId}/connections |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get connections to the specified contact for the requestor contact
*/
@Api(Description="Get connections to the specified contact for the requestor contact")
public static class GetConnectionsToContact extends PagedModel
{
/**
* Contact Id to get connections for
*/
@ApiMember(DataType="Guid", Description="Contact Id to get connections for", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)
*/
@ApiMember(DataType="Guid", Description="Type of the contact to get connections for (i.e. Real/ virtual Person/ Organisation)", IsRequired=true, Name="ContactTypeId")
public UUID ContactTypeId = null;
/**
* Contact Id requesting the details - Current user or licensee
*/
@ApiMember(DataType="Guid", Description="Contact Id requesting the details - Current user or licensee", IsRequired=true, Name="RequestorContactId")
public UUID RequestorContactId = null;
/**
* Return all connections or paged results?
*/
@ApiMember(Description="Return all connections or paged results?", Name="IsPagedMode")
public Boolean IsPagedMode = null;
/**
* Option to return removed connections
*/
@ApiMember(Description="Option to return removed connections", Name="IncludeRemoved")
public Boolean IncludeRemoved = null;
public UUID getContactId() { return ContactId; }
public GetConnectionsToContact setContactId(UUID value) { this.ContactId = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public GetConnectionsToContact setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
public UUID getRequestorContactId() { return RequestorContactId; }
public GetConnectionsToContact setRequestorContactId(UUID value) { this.RequestorContactId = value; return this; }
public Boolean getIsPagedMode() { return IsPagedMode; }
public GetConnectionsToContact setIsPagedMode(Boolean value) { this.IsPagedMode = value; return this; }
public Boolean isIncludeRemoved() { return IncludeRemoved; }
public GetConnectionsToContact setIncludeRemoved(Boolean value) { this.IncludeRemoved = value; return this; }
}
public static class PagedModel
{
/**
* Page Number to retrieve
*/
@ApiMember(DataType="int", Description="Page Number to retrieve", Name="PageNumber")
public Integer PageNumber = null;
/**
* Number of records to retrieve
*/
@ApiMember(DataType="int", Description="Number of records to retrieve", Name="PageSize")
public Integer PageSize = null;
/**
* Index of field to sort results by
*/
@ApiMember(DataType="int", Description="Index of field to sort results by", Name="SortIndex")
public Integer SortIndex = null;
/**
* Sort Order - Ascending or Descending
*/
@ApiMember(DataType="int", Description="Sort Order - Ascending or Descending", Name="SortOrder")
public SortOrder SortOrder = null;
public Integer getPageNumber() { return PageNumber; }
public PagedModel setPageNumber(Integer value) { this.PageNumber = value; return this; }
public Integer getPageSize() { return PageSize; }
public PagedModel setPageSize(Integer value) { this.PageSize = value; return this; }
public Integer getSortIndex() { return SortIndex; }
public PagedModel setSortIndex(Integer value) { this.SortIndex = value; return this; }
public SortOrder getSortOrder() { return SortOrder; }
public PagedModel setSortOrder(SortOrder value) { this.SortOrder = value; return this; }
}
public static enum SortOrder
{
Ascending,
Descending;
}
@ApiResponse(Description="Connections to the specified contact for the requestor contact")
public static class GetConnectionsToContactResponse
{
public ArrayList<ContactConnectionModel> Connections = null;
public Integer TotalConnections = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<ContactConnectionModel> getConnections() { return Connections; }
public GetConnectionsToContactResponse setConnections(ArrayList<ContactConnectionModel> value) { this.Connections = value; return this; }
public Integer getTotalConnections() { return TotalConnections; }
public GetConnectionsToContactResponse setTotalConnections(Integer value) { this.TotalConnections = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetConnectionsToContactResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class ContactConnectionModel
{
/**
* Connection Id (if applicable)
*/
@ApiMember(DataType="Guid?", Description="Connection Id (if applicable)", Name="ConnectionId")
public UUID ConnectionId = null;
/**
* Connection Request Id (if applicable)
*/
@ApiMember(DataType="Guid?", Description="Connection Request Id (if applicable)", Name="ConnectionRequestId")
public UUID ConnectionRequestId = null;
/**
* Details of the contact
*/
@ApiMember(DataType="ContactSummaryModel", Description="Details of the contact", IsRequired=true, Name="Contact")
public ContactSummaryModel Contact = null;
/**
* Contact's role Id in the connection
*/
@ApiMember(DataType="Guid", Description="Contact's role Id in the connection", IsRequired=true, Name="ContactRoleId")
public UUID ContactRoleId = null;
/**
* Contact's role name in the connection
*/
@ApiMember(DataType="string", Description="Contact's role name in the connection", Name="ContactRoleName")
public String ContactRoleName = null;
/**
* Requestor Contact Id
*/
@ApiMember(DataType="Guid", Description="Requestor Contact Id", IsRequired=true, Name="RequestorContactId")
public UUID RequestorContactId = null;
/**
* Requestor Contact Name
*/
@ApiMember(DataType="Guid", Description="Requestor Contact Name", Name="RequestorContactName")
public String RequestorContactName = null;
/**
* Requestor contact's role Id in the connection
*/
@ApiMember(DataType="Guid", Description="Requestor contact's role Id in the connection", IsRequired=true, Name="RequestorRoleId")
public UUID RequestorRoleId = null;
/**
* Requestor's role name in the connection
*/
@ApiMember(DataType="string", Description="Requestor's role name in the connection", Name="RequestorRoleName")
public String RequestorRoleName = null;
/**
* Primary role in the connection to display
*/
@ApiMember(DataType="string", Description="Primary role in the connection to display", Name="PrimaryRoleName")
public String PrimaryRoleName = null;
/**
* Connection Status Id
*/
@ApiMember(DataType="Guid", Description="Connection Status Id", IsRequired=true, Name="ConnectionStatusId")
public UUID ConnectionStatusId = null;
/**
* Connection Status Name
*/
@ApiMember(DataType="string", Description="Connection Status Name", Name="ConnectionStatusName")
public String ConnectionStatusName = null;
/**
* Is this a pending connection request?
*/
@ApiMember(DataType="bool", Description="Is this a pending connection request?", Name="IsConnectionRequest")
public Boolean IsConnectionRequest = null;
/**
* Is this an incoming connection request?
*/
@ApiMember(DataType="bool", Description="Is this an incoming connection request?", Name="IsIncoming")
public Boolean IsIncoming = null;
public Date FromDate = null;
/**
* Details of the contact suggesting this connection
*/
@ApiMember(DataType="ContactSummaryModel", Description="Details of the contact suggesting this connection", IsRequired=true, Name="SuggesterContact")
public ContactSummaryModel SuggesterContact = null;
/**
* Can this connection be cancelled?
*/
@ApiMember(DataType="bool", Description="Can this connection be cancelled?", Name="AllowCancel")
public Boolean AllowCancel = null;
/**
* Can this connection be removed?
*/
@ApiMember(DataType="bool", Description="Can this connection be removed?", Name="AllowRemove")
public Boolean AllowRemove = null;
public UUID getConnectionId() { return ConnectionId; }
public ContactConnectionModel setConnectionId(UUID value) { this.ConnectionId = value; return this; }
public UUID getConnectionRequestId() { return ConnectionRequestId; }
public ContactConnectionModel setConnectionRequestId(UUID value) { this.ConnectionRequestId = value; return this; }
public ContactSummaryModel getContact() { return Contact; }
public ContactConnectionModel setContact(ContactSummaryModel value) { this.Contact = value; return this; }
public UUID getContactRoleId() { return ContactRoleId; }
public ContactConnectionModel setContactRoleId(UUID value) { this.ContactRoleId = value; return this; }
public String getContactRoleName() { return ContactRoleName; }
public ContactConnectionModel setContactRoleName(String value) { this.ContactRoleName = value; return this; }
public UUID getRequestorContactId() { return RequestorContactId; }
public ContactConnectionModel setRequestorContactId(UUID value) { this.RequestorContactId = value; return this; }
public String getRequestorContactName() { return RequestorContactName; }
public ContactConnectionModel setRequestorContactName(String value) { this.RequestorContactName = value; return this; }
public UUID getRequestorRoleId() { return RequestorRoleId; }
public ContactConnectionModel setRequestorRoleId(UUID value) { this.RequestorRoleId = value; return this; }
public String getRequestorRoleName() { return RequestorRoleName; }
public ContactConnectionModel setRequestorRoleName(String value) { this.RequestorRoleName = value; return this; }
public String getPrimaryRoleName() { return PrimaryRoleName; }
public ContactConnectionModel setPrimaryRoleName(String value) { this.PrimaryRoleName = value; return this; }
public UUID getConnectionStatusId() { return ConnectionStatusId; }
public ContactConnectionModel setConnectionStatusId(UUID value) { this.ConnectionStatusId = value; return this; }
public String getConnectionStatusName() { return ConnectionStatusName; }
public ContactConnectionModel setConnectionStatusName(String value) { this.ConnectionStatusName = value; return this; }
public Boolean getIsConnectionRequest() { return IsConnectionRequest; }
public ContactConnectionModel setIsConnectionRequest(Boolean value) { this.IsConnectionRequest = value; return this; }
public Boolean getIsIncoming() { return IsIncoming; }
public ContactConnectionModel setIsIncoming(Boolean value) { this.IsIncoming = value; return this; }
public Date getFromDate() { return FromDate; }
public ContactConnectionModel setFromDate(Date value) { this.FromDate = value; return this; }
public ContactSummaryModel getSuggesterContact() { return SuggesterContact; }
public ContactConnectionModel setSuggesterContact(ContactSummaryModel value) { this.SuggesterContact = value; return this; }
public Boolean isAllowCancel() { return AllowCancel; }
public ContactConnectionModel setAllowCancel(Boolean value) { this.AllowCancel = value; return this; }
public Boolean isAllowRemove() { return AllowRemove; }
public ContactConnectionModel setAllowRemove(Boolean value) { this.AllowRemove = value; return this; }
}
public static class ContactSummaryModel
{
/**
* Contact linked to the profile
*/
@ApiMember(DataType="Guid", Description="Contact linked to the profile", Name="ContactId")
public UUID ContactId = null;
/**
* Full name of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Full name of the contact linked to the profile", Name="ContactFullName")
public String ContactFullName = null;
/**
* Email Address of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Email Address of the contact linked to the profile", Name="EmailAddress")
public String EmailAddress = null;
/**
* Mobile Number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Mobile Number of the contact linked to the profile", Name="MobileNumber")
public String MobileNumber = null;
/**
* Primary Phone Number of the contact linked to the profile
*/
@ApiMember(DataType="string", Description="Primary Phone Number of the contact linked to the profile", Name="PhoneNumber")
public String PhoneNumber = null;
/**
* Type of contact (person, organisation etc.) linked to the profile
*/
@ApiMember(DataType="string", Description="Type of contact (person, organisation etc.) linked to the profile", Name="ContactTypeId")
public UUID ContactTypeId = null;
/**
* Profile photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Profile photo of contact linked to the profile", Name="ProfilePhotoUrl")
public String ProfilePhotoUrl = null;
/**
* Thumbnail photo of contact linked to the profile
*/
@ApiMember(DataType="string", Description="Thumbnail photo of contact linked to the profile", Name="ProfilePhotoThumbnailUrl")
public String ProfilePhotoThumbnailUrl = null;
/**
* Profile description
*/
@ApiMember(DataType="string", Description="Profile description", Name="Description")
public String Description = null;
/**
* Employment Industry
*/
@ApiMember(DataType="string", Description="Employment Industry", Name="EmploymentIndustry")
public String EmploymentIndustry = null;
/**
* Employment Role
*/
@ApiMember(DataType="string", Description="Employment Role", Name="EmploymentRole")
public String EmploymentRole = null;
/**
* Areas of Work
*/
@ApiMember(DataType="string", Description="Areas of Work", Name="EmploymentGeographicArea")
public String EmploymentGeographicArea = null;
/**
* Timezone Name
*/
@ApiMember(DataType="string", Description="Timezone Name", Name="TimezoneName", ParameterType="query")
public String TimezoneName = null;
/**
* The primary address of the contact
*/
@ApiMember(DataType="string", Description="The primary address of the contact", Name="PrimaryAddress", ParameterType="query")
public String PrimaryAddress = null;
/**
* Have all connections to the contact been removed?
*/
@ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact")
public Boolean IsRemovedContact = null;
public UUID getContactId() { return ContactId; }
public ContactSummaryModel setContactId(UUID value) { this.ContactId = value; return this; }
public String getContactFullName() { return ContactFullName; }
public ContactSummaryModel setContactFullName(String value) { this.ContactFullName = value; return this; }
public String getEmailAddress() { return EmailAddress; }
public ContactSummaryModel setEmailAddress(String value) { this.EmailAddress = value; return this; }
public String getMobileNumber() { return MobileNumber; }
public ContactSummaryModel setMobileNumber(String value) { this.MobileNumber = value; return this; }
public String getPhoneNumber() { return PhoneNumber; }
public ContactSummaryModel setPhoneNumber(String value) { this.PhoneNumber = value; return this; }
public UUID getContactTypeId() { return ContactTypeId; }
public ContactSummaryModel setContactTypeId(UUID value) { this.ContactTypeId = value; return this; }
public String getProfilePhotoUrl() { return ProfilePhotoUrl; }
public ContactSummaryModel setProfilePhotoUrl(String value) { this.ProfilePhotoUrl = value; return this; }
public String getProfilePhotoThumbnailUrl() { return ProfilePhotoThumbnailUrl; }
public ContactSummaryModel setProfilePhotoThumbnailUrl(String value) { this.ProfilePhotoThumbnailUrl = value; return this; }
public String getDescription() { return Description; }
public ContactSummaryModel setDescription(String value) { this.Description = value; return this; }
public String getEmploymentIndustry() { return EmploymentIndustry; }
public ContactSummaryModel setEmploymentIndustry(String value) { this.EmploymentIndustry = value; return this; }
public String getEmploymentRole() { return EmploymentRole; }
public ContactSummaryModel setEmploymentRole(String value) { this.EmploymentRole = value; return this; }
public String getEmploymentGeographicArea() { return EmploymentGeographicArea; }
public ContactSummaryModel setEmploymentGeographicArea(String value) { this.EmploymentGeographicArea = value; return this; }
public String getTimezoneName() { return TimezoneName; }
public ContactSummaryModel setTimezoneName(String value) { this.TimezoneName = value; return this; }
public String getPrimaryAddress() { return PrimaryAddress; }
public ContactSummaryModel setPrimaryAddress(String value) { this.PrimaryAddress = value; return this; }
public Boolean getIsRemovedContact() { return IsRemovedContact; }
public ContactSummaryModel setIsRemovedContact(Boolean value) { this.IsRemovedContact = value; return this; }
}
}
Java GetConnectionsToContact 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/contacts/{ContactId}/connections HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
IsPagedMode: False,
IncludeRemoved: False,
PageNumber: 0,
PageSize: 0,
SortIndex: 0,
SortOrder: Ascending
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Connections:
[
{
ConnectionId: 00000000000000000000000000000000,
ConnectionRequestId: 00000000000000000000000000000000,
Contact:
{
ContactFullName: String,
EmailAddress: String,
MobileNumber: String,
PhoneNumber: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsRemovedContact: False
},
ContactRoleName: String,
RequestorContactName: String,
RequestorRoleName: String,
PrimaryRoleName: String,
ConnectionStatusName: String,
IsConnectionRequest: False,
IsIncoming: False,
FromDate: 0001-01-01,
SuggesterContact:
{
ContactFullName: String,
EmailAddress: String,
MobileNumber: String,
PhoneNumber: String,
ProfilePhotoUrl: String,
ProfilePhotoThumbnailUrl: String,
Description: String,
EmploymentIndustry: String,
EmploymentRole: String,
EmploymentGeographicArea: String,
TimezoneName: String,
PrimaryAddress: String,
IsRemovedContact: False
},
AllowCancel: False,
AllowRemove: False
}
],
TotalConnections: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}