| All Verbs | /api/contacts/{ContactId}/connectionrequests/received | ||
|---|---|---|---|
| All Verbs | /api/contacts/{ContactId}/connectionrequests/sent |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class GetConnectionRequests
{
/**
* Contact to get connection requests for
*/
@ApiMember(Description="Contact to get connection requests for", IsRequired=true, Name="ContactId")
public UUID ContactId = null;
/**
* Filter connection requests for the specified contact types
*/
@ApiMember(Description="Filter connection requests for the specified contact types", IsRequired=true, Name="ContactTypes")
public ArrayList<UUID> ContactTypes = new ArrayList<UUID>();
/**
* Include ignored connection requests?
*/
@ApiMember(Description="Include ignored connection requests?", IsRequired=true, Name="IncludeIgnoredRequests")
public Boolean IncludeIgnoredRequests = null;
public UUID getContactId() { return ContactId; }
public GetConnectionRequests setContactId(UUID value) { this.ContactId = value; return this; }
public ArrayList<UUID> getContactTypes() { return ContactTypes; }
public GetConnectionRequests setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
public Boolean isIncludeIgnoredRequests() { return IncludeIgnoredRequests; }
public GetConnectionRequests setIncludeIgnoredRequests(Boolean value) { this.IncludeIgnoredRequests = value; return this; }
}
public static class GetConnectionRequestsResponse
{
public ArrayList<ContactConnectionModel> ConnectionRequests = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<ContactConnectionModel> getConnectionRequests() { return ConnectionRequests; }
public GetConnectionRequestsResponse setConnectionRequests(ArrayList<ContactConnectionModel> value) { this.ConnectionRequests = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetConnectionRequestsResponse 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 GetConnectionRequests DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/contacts/{ContactId}/connectionrequests/received HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ContactId":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeIgnoredRequests":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ConnectionRequests":[{"ConnectionId":"00000000000000000000000000000000","ConnectionRequestId":"00000000000000000000000000000000","Contact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"ContactRoleId":"00000000-0000-0000-0000-000000000000","ContactRoleName":"String","RequestorContactId":"00000000-0000-0000-0000-000000000000","RequestorContactName":"String","RequestorRoleId":"00000000-0000-0000-0000-000000000000","RequestorRoleName":"String","PrimaryRoleName":"String","ConnectionStatusId":"00000000-0000-0000-0000-000000000000","ConnectionStatusName":"String","IsConnectionRequest":false,"IsIncoming":false,"FromDate":"0001-01-01T00:00:00.0000000","SuggesterContact":{"ContactId":"00000000-0000-0000-0000-000000000000","ContactFullName":"String","EmailAddress":"String","MobileNumber":"String","PhoneNumber":"String","ContactTypeId":"00000000-0000-0000-0000-000000000000","ProfilePhotoUrl":"String","ProfilePhotoThumbnailUrl":"String","Description":"String","EmploymentIndustry":"String","EmploymentRole":"String","EmploymentGeographicArea":"String","TimezoneName":"String","PrimaryAddress":"String","IsRemovedContact":false},"AllowCancel":false,"AllowRemove":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}