regis

<back to all web services

PersonSearchRequest

Requires Authentication
Required permission:SearchPerson
The following routes are available for this service:
POST/person/search/page/{Page}
POST/person/search
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PersonSearchRequest
    {
        public Integer page = null;
        public Integer regent_id = null;
        public String regent_login = null;
        public String name = null;
        public String last_name = null;
        public String email = null;
        public String phone = null;
        public Date dob = null;
        
        public Integer getPage() { return page; }
        public PersonSearchRequest setPage(Integer value) { this.page = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonSearchRequest setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getRegentLogin() { return regent_login; }
        public PersonSearchRequest setRegentLogin(String value) { this.regent_login = value; return this; }
        public String getName() { return name; }
        public PersonSearchRequest setName(String value) { this.name = value; return this; }
        public String getLastName() { return last_name; }
        public PersonSearchRequest setLastName(String value) { this.last_name = value; return this; }
        public String getEmail() { return email; }
        public PersonSearchRequest setEmail(String value) { this.email = value; return this; }
        public String getPhone() { return phone; }
        public PersonSearchRequest setPhone(String value) { this.phone = value; return this; }
        public Date getDob() { return dob; }
        public PersonSearchRequest setDob(Date value) { this.dob = value; return this; }
    }

    public static class PersonSearchResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<PersonSimpleResponse> persons = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonSearchResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<PersonSimpleResponse> getPersons() { return persons; }
        public PersonSearchResponse setPersons(ArrayList<PersonSimpleResponse> value) { this.persons = value; return this; }
    }

    public static class PersonSimpleResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public Integer ubc_id = null;
        public String uuid = null;
        public String regent_login = null;
        public String first_name = null;
        public String preferred_name = null;
        public String middle_name = null;
        public String last_name = null;
        public String email = null;
        public String phone_home = null;
        public String phone_cell = null;
        public String phone_bus = null;
        public String addr1 = null;
        public String addr2 = null;
        public String city = null;
        public String state = null;
        public String country = null;
        public String code = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public Date dob = null;
        public Boolean is_student = null;
        public Boolean is_faculty = null;
        public Boolean is_vendor = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonSimpleResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public Integer getUbcId() { return ubc_id; }
        public PersonSimpleResponse setUbcId(Integer value) { this.ubc_id = value; return this; }
        public String getUuid() { return uuid; }
        public PersonSimpleResponse setUuid(String value) { this.uuid = value; return this; }
        public String getRegentLogin() { return regent_login; }
        public PersonSimpleResponse setRegentLogin(String value) { this.regent_login = value; return this; }
        public String getFirstName() { return first_name; }
        public PersonSimpleResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public PersonSimpleResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public PersonSimpleResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getLastName() { return last_name; }
        public PersonSimpleResponse setLastName(String value) { this.last_name = value; return this; }
        public String getEmail() { return email; }
        public PersonSimpleResponse setEmail(String value) { this.email = value; return this; }
        public String getPhoneHome() { return phone_home; }
        public PersonSimpleResponse setPhoneHome(String value) { this.phone_home = value; return this; }
        public String getPhoneCell() { return phone_cell; }
        public PersonSimpleResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
        public String getPhoneBus() { return phone_bus; }
        public PersonSimpleResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
        public String getAddr1() { return addr1; }
        public PersonSimpleResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public PersonSimpleResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCity() { return city; }
        public PersonSimpleResponse setCity(String value) { this.city = value; return this; }
        public String getState() { return state; }
        public PersonSimpleResponse setState(String value) { this.state = value; return this; }
        public String getCountry() { return country; }
        public PersonSimpleResponse setCountry(String value) { this.country = value; return this; }
        public String getCode() { return code; }
        public PersonSimpleResponse setCode(String value) { this.code = value; return this; }
        public String getCitizenship() { return citizenship; }
        public PersonSimpleResponse setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public PersonSimpleResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public PersonSimpleResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public Date getDob() { return dob; }
        public PersonSimpleResponse setDob(Date value) { this.dob = value; return this; }
        public Boolean getIsStudent() { return is_student; }
        public PersonSimpleResponse setIsStudent(Boolean value) { this.is_student = value; return this; }
        public Boolean getIsFaculty() { return is_faculty; }
        public PersonSimpleResponse setIsFaculty(Boolean value) { this.is_faculty = value; return this; }
        public Boolean getIsVendor() { return is_vendor; }
        public PersonSimpleResponse setIsVendor(Boolean value) { this.is_vendor = value; return this; }
    }

}

Java PersonSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /person/search/page/{Page} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <Page>0</Page>
  <dob>0001-01-01T00:00:00</dob>
  <email>String</email>
  <last_name>String</last_name>
  <name>String</name>
  <phone>String</phone>
  <regent_id>0</regent_id>
  <regent_login>String</regent_login>
</PersonSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PersonSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <Persons>
    <PersonSimpleResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <addr1>String</addr1>
      <addr2>String</addr2>
      <citizenship>String</citizenship>
      <citizenship_other>String</citizenship_other>
      <city>String</city>
      <code>String</code>
      <country>String</country>
      <dob>0001-01-01T00:00:00</dob>
      <email>String</email>
      <first_name>String</first_name>
      <is_faculty>false</is_faculty>
      <is_student>false</is_student>
      <is_vendor>false</is_vendor>
      <last_name>String</last_name>
      <middle_name>String</middle_name>
      <permanent_resident>String</permanent_resident>
      <phone_bus>String</phone_bus>
      <phone_cell>String</phone_cell>
      <phone_home>String</phone_home>
      <preferred_name>String</preferred_name>
      <regent_id>0</regent_id>
      <regent_login>String</regent_login>
      <state>String</state>
      <ubc_id>0</ubc_id>
      <uuid>String</uuid>
    </PersonSimpleResponse>
  </Persons>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PersonSearchResponse>