| All Verbs | /api/searchcontactsforroles |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Search contacts by Name or Email Address, by Role Groups, or by Roles
*/
@Api(Description="Search contacts by Name or Email Address, by Role Groups, or by Roles")
public static class SearchContactsForRole
{
/**
* Search type: by Name or Email Address, by Role Groups, or by Roles
*/
@ApiMember(DataType="Guid", Description="Search type: by Name or Email Address, by Role Groups, or by Roles", IsRequired=true, Name="SearchBy")
public UUID SearchBy = null;
/**
* Roles that contacts are connected to.
*/
@ApiMember(DataType="List<Guid>", Description="Roles that contacts are connected to.", Name="Roles")
public ArrayList<UUID> Roles = null;
/**
* Role Groups that contacts are connected to.
*/
@ApiMember(DataType="List<Guid>", Description="Role Groups that contacts are connected to.", Name="RoleGroups")
public ArrayList<UUID> RoleGroups = null;
/**
* For Search by Name or Email Address, filters contact results by this text value.
*/
@ApiMember(DataType="string", Description="For Search by Name or Email Address, filters contact results by this text value.", Name="SearchText")
public String SearchText = null;
/**
* Excludes contacts already connected to this role.
*/
@ApiMember(DataType="Guid", Description="Excludes contacts already connected to this role.", Name="ExcludeRole")
public UUID ExcludeRole = null;
/**
* Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.
*/
@ApiMember(DataType="List<Guid>", Description="Filters contact results by contact type(s) provided, e.g. Real Persons, Organisations etc. Defaults to real person.", Name="ContactTypes")
public ArrayList<UUID> ContactTypes = null;
/**
* Determines whether the contact details (Email, mobile number etc.) to be returned.
*/
@ApiMember(DataType="Bool", Description="Determines whether the contact details (Email, mobile number etc.) to be returned.", Name="IncludeDetails")
public Boolean IncludeDetails = null;
public UUID getSearchBy() { return SearchBy; }
public SearchContactsForRole setSearchBy(UUID value) { this.SearchBy = value; return this; }
public ArrayList<UUID> getRoles() { return Roles; }
public SearchContactsForRole setRoles(ArrayList<UUID> value) { this.Roles = value; return this; }
public ArrayList<UUID> getRoleGroups() { return RoleGroups; }
public SearchContactsForRole setRoleGroups(ArrayList<UUID> value) { this.RoleGroups = value; return this; }
public String getSearchText() { return SearchText; }
public SearchContactsForRole setSearchText(String value) { this.SearchText = value; return this; }
public UUID getExcludeRole() { return ExcludeRole; }
public SearchContactsForRole setExcludeRole(UUID value) { this.ExcludeRole = value; return this; }
public ArrayList<UUID> getContactTypes() { return ContactTypes; }
public SearchContactsForRole setContactTypes(ArrayList<UUID> value) { this.ContactTypes = value; return this; }
public Boolean isIncludeDetails() { return IncludeDetails; }
public SearchContactsForRole setIncludeDetails(Boolean value) { this.IncludeDetails = value; return this; }
}
public static class SearchContactsForRoleResponse
{
public ArrayList<ContactSummaryModel> Contacts = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<ContactSummaryModel> getContacts() { return Contacts; }
public SearchContactsForRoleResponse setContacts(ArrayList<ContactSummaryModel> value) { this.Contacts = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SearchContactsForRoleResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = 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 SearchContactsForRole 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/searchcontactsforroles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/json
Content-Type: application/json
Content-Length: length
{"SearchBy":"00000000-0000-0000-0000-000000000000","Roles":["00000000-0000-0000-0000-000000000000"],"RoleGroups":["00000000-0000-0000-0000-000000000000"],"SearchText":"String","ExcludeRole":"00000000-0000-0000-0000-000000000000","ContactTypes":["00000000-0000-0000-0000-000000000000"],"IncludeDetails":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Contacts":[{"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}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}