regis

<back to all web services

PersonBaseValuesRequest

Requires Authentication
Required permission:ReadPersonBaseValues
The following routes are available for this service:
POST/person/baseValues
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PersonBaseValuesRequest
    {
        
    }

    public static class PersonBaseValuesResponse
    {
        public ResponseStatus responseStatus = null;
        public PersonExtendedResponse person = null;
        public ArrayList<CountriesAndStatesResponse> countriesAndStates = null;
        public ArrayList<PrefixResponse> prefixes = null;
        public HashMap<String,String> maritalStatuses = null;
        public ArrayList<Denomination> denominations = null;
        public ArrayList<Occupation> occupations = null;
        public ArrayList<Ethnicity> ethnicities = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonBaseValuesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public PersonExtendedResponse getPerson() { return person; }
        public PersonBaseValuesResponse setPerson(PersonExtendedResponse value) { this.person = value; return this; }
        public ArrayList<CountriesAndStatesResponse> getCountriesAndStates() { return countriesAndStates; }
        public PersonBaseValuesResponse setCountriesAndStates(ArrayList<CountriesAndStatesResponse> value) { this.countriesAndStates = value; return this; }
        public ArrayList<PrefixResponse> getPrefixes() { return prefixes; }
        public PersonBaseValuesResponse setPrefixes(ArrayList<PrefixResponse> value) { this.prefixes = value; return this; }
        public HashMap<String,String> getMaritalStatuses() { return maritalStatuses; }
        public PersonBaseValuesResponse setMaritalStatuses(HashMap<String,String> value) { this.maritalStatuses = value; return this; }
        public ArrayList<Denomination> getDenominations() { return denominations; }
        public PersonBaseValuesResponse setDenominations(ArrayList<Denomination> value) { this.denominations = value; return this; }
        public ArrayList<Occupation> getOccupations() { return occupations; }
        public PersonBaseValuesResponse setOccupations(ArrayList<Occupation> value) { this.occupations = value; return this; }
        public ArrayList<Ethnicity> getEthnicities() { return ethnicities; }
        public PersonBaseValuesResponse setEthnicities(ArrayList<Ethnicity> value) { this.ethnicities = value; return this; }
    }

    public static class PersonExtendedResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public Integer ubc_id = null;
        public Integer spouse_regent_id = null;
        public String uuid = null;
        public String regent_login = null;
        public String spouse_rwl = null;
        public String first_name = null;
        public String middle_name = null;
        public String last_name = null;
        public String preferred_name = null;
        public String birth_name = null;
        public String override_transcript_name = null;
        public String spouse_name = null;
        public String addr1 = null;
        public String addr2 = null;
        public String country = null;
        public String state = null;
        public String city = null;
        public String code = null;
        public String phone_home = null;
        public String phone_cell = null;
        public String phone_bus = null;
        public String email = null;
        public String prefix = null;
        public Date dob = null;
        public String citizenship = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public String denomination = null;
        public String occupation = null;
        public String ethnicity = null;
        public String gender = null;
        public String marital_status = null;
        public Date deceased_date = null;
        public Boolean is_donor = null;
        public Boolean is_vendor = null;
        public Boolean is_gp_customer = null;
        public String crm_student_status = null;
        public String crm_assigned = null;
        public String last_registered_term = null;
        public Boolean is_regent_staff = null;
        public String regent_title = null;
        public String regent_department = null;
        public String regent_faculty_profile_url = null;
        public String regent_image_url = null;
        public Boolean include_on_website = null;
        public String added_by = null;
        public Date added_date = null;
        public String last_changed_by = null;
        public Date last_changed_date = null;
        public String addr_last_changed_by = null;
        public Date addr_last_changed_date = null;
        public String tax_number = null;
        public String regent_current_program = null;
        public String regent_degrees = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public PersonExtendedResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public PersonExtendedResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public Integer getUbcId() { return ubc_id; }
        public PersonExtendedResponse setUbcId(Integer value) { this.ubc_id = value; return this; }
        public Integer getSpouseRegentId() { return spouse_regent_id; }
        public PersonExtendedResponse setSpouseRegentId(Integer value) { this.spouse_regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public PersonExtendedResponse setUuid(String value) { this.uuid = value; return this; }
        public String getRegentLogin() { return regent_login; }
        public PersonExtendedResponse setRegentLogin(String value) { this.regent_login = value; return this; }
        public String getSpouseRwl() { return spouse_rwl; }
        public PersonExtendedResponse setSpouseRwl(String value) { this.spouse_rwl = value; return this; }
        public String getFirstName() { return first_name; }
        public PersonExtendedResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public PersonExtendedResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getLastName() { return last_name; }
        public PersonExtendedResponse setLastName(String value) { this.last_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public PersonExtendedResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getBirthName() { return birth_name; }
        public PersonExtendedResponse setBirthName(String value) { this.birth_name = value; return this; }
        public String getOverrideTranscriptName() { return override_transcript_name; }
        public PersonExtendedResponse setOverrideTranscriptName(String value) { this.override_transcript_name = value; return this; }
        public String getSpouseName() { return spouse_name; }
        public PersonExtendedResponse setSpouseName(String value) { this.spouse_name = value; return this; }
        public String getAddr1() { return addr1; }
        public PersonExtendedResponse setAddr1(String value) { this.addr1 = value; return this; }
        public String getAddr2() { return addr2; }
        public PersonExtendedResponse setAddr2(String value) { this.addr2 = value; return this; }
        public String getCountry() { return country; }
        public PersonExtendedResponse setCountry(String value) { this.country = value; return this; }
        public String getState() { return state; }
        public PersonExtendedResponse setState(String value) { this.state = value; return this; }
        public String getCity() { return city; }
        public PersonExtendedResponse setCity(String value) { this.city = value; return this; }
        public String getCode() { return code; }
        public PersonExtendedResponse setCode(String value) { this.code = value; return this; }
        public String getPhoneHome() { return phone_home; }
        public PersonExtendedResponse setPhoneHome(String value) { this.phone_home = value; return this; }
        public String getPhoneCell() { return phone_cell; }
        public PersonExtendedResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
        public String getPhoneBus() { return phone_bus; }
        public PersonExtendedResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
        public String getEmail() { return email; }
        public PersonExtendedResponse setEmail(String value) { this.email = value; return this; }
        public String getPrefix() { return prefix; }
        public PersonExtendedResponse setPrefix(String value) { this.prefix = value; return this; }
        public Date getDob() { return dob; }
        public PersonExtendedResponse setDob(Date value) { this.dob = value; return this; }
        public String getCitizenship() { return citizenship; }
        public PersonExtendedResponse setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public PersonExtendedResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public PersonExtendedResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public String getDenomination() { return denomination; }
        public PersonExtendedResponse setDenomination(String value) { this.denomination = value; return this; }
        public String getOccupation() { return occupation; }
        public PersonExtendedResponse setOccupation(String value) { this.occupation = value; return this; }
        public String getEthnicity() { return ethnicity; }
        public PersonExtendedResponse setEthnicity(String value) { this.ethnicity = value; return this; }
        public String getGender() { return gender; }
        public PersonExtendedResponse setGender(String value) { this.gender = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public PersonExtendedResponse setMaritalStatus(String value) { this.marital_status = value; return this; }
        public Date getDeceasedDate() { return deceased_date; }
        public PersonExtendedResponse setDeceasedDate(Date value) { this.deceased_date = value; return this; }
        public Boolean getIsDonor() { return is_donor; }
        public PersonExtendedResponse setIsDonor(Boolean value) { this.is_donor = value; return this; }
        public Boolean getIsVendor() { return is_vendor; }
        public PersonExtendedResponse setIsVendor(Boolean value) { this.is_vendor = value; return this; }
        public Boolean getIsGpCustomer() { return is_gp_customer; }
        public PersonExtendedResponse setIsGpCustomer(Boolean value) { this.is_gp_customer = value; return this; }
        public String getCrmStudentStatus() { return crm_student_status; }
        public PersonExtendedResponse setCrmStudentStatus(String value) { this.crm_student_status = value; return this; }
        public String getCrmAssigned() { return crm_assigned; }
        public PersonExtendedResponse setCrmAssigned(String value) { this.crm_assigned = value; return this; }
        public String getLastRegisteredTerm() { return last_registered_term; }
        public PersonExtendedResponse setLastRegisteredTerm(String value) { this.last_registered_term = value; return this; }
        public Boolean getIsRegentStaff() { return is_regent_staff; }
        public PersonExtendedResponse setIsRegentStaff(Boolean value) { this.is_regent_staff = value; return this; }
        public String getRegentTitle() { return regent_title; }
        public PersonExtendedResponse setRegentTitle(String value) { this.regent_title = value; return this; }
        public String getRegentDepartment() { return regent_department; }
        public PersonExtendedResponse setRegentDepartment(String value) { this.regent_department = value; return this; }
        public String getRegentFacultyProfileUrl() { return regent_faculty_profile_url; }
        public PersonExtendedResponse setRegentFacultyProfileUrl(String value) { this.regent_faculty_profile_url = value; return this; }
        public String getRegentImageUrl() { return regent_image_url; }
        public PersonExtendedResponse setRegentImageUrl(String value) { this.regent_image_url = value; return this; }
        public Boolean isIncludeOnWebsite() { return include_on_website; }
        public PersonExtendedResponse setIncludeOnWebsite(Boolean value) { this.include_on_website = value; return this; }
        public String getAddedBy() { return added_by; }
        public PersonExtendedResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public PersonExtendedResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getLastChangedBy() { return last_changed_by; }
        public PersonExtendedResponse setLastChangedBy(String value) { this.last_changed_by = value; return this; }
        public Date getLastChangedDate() { return last_changed_date; }
        public PersonExtendedResponse setLastChangedDate(Date value) { this.last_changed_date = value; return this; }
        public String getAddrLastChangedBy() { return addr_last_changed_by; }
        public PersonExtendedResponse setAddrLastChangedBy(String value) { this.addr_last_changed_by = value; return this; }
        public Date getAddrLastChangedDate() { return addr_last_changed_date; }
        public PersonExtendedResponse setAddrLastChangedDate(Date value) { this.addr_last_changed_date = value; return this; }
        public String getTaxNumber() { return tax_number; }
        public PersonExtendedResponse setTaxNumber(String value) { this.tax_number = value; return this; }
        public String getRegentCurrentProgram() { return regent_current_program; }
        public PersonExtendedResponse setRegentCurrentProgram(String value) { this.regent_current_program = value; return this; }
        public String getRegentDegrees() { return regent_degrees; }
        public PersonExtendedResponse setRegentDegrees(String value) { this.regent_degrees = value; return this; }
    }

    public static class CountriesAndStatesResponse
    {
        public String country_code = null;
        public String country_name = null;
        public HashMap<String,String> states = null;
        
        public String getCountryCode() { return country_code; }
        public CountriesAndStatesResponse setCountryCode(String value) { this.country_code = value; return this; }
        public String getCountryName() { return country_name; }
        public CountriesAndStatesResponse setCountryName(String value) { this.country_name = value; return this; }
        public HashMap<String,String> getStates() { return states; }
        public CountriesAndStatesResponse setStates(HashMap<String,String> value) { this.states = value; return this; }
    }

    public static class PrefixResponse
    {
        public String prefix_code = null;
        public String prefix_name = null;
        
        public String getPrefixCode() { return prefix_code; }
        public PrefixResponse setPrefixCode(String value) { this.prefix_code = value; return this; }
        public String getPrefixName() { return prefix_name; }
        public PrefixResponse setPrefixName(String value) { this.prefix_name = value; return this; }
    }

    public static class Denomination
    {
        public Integer id = null;
        public String code = null;
        public String denomination_name = null;
        
        public Integer getId() { return id; }
        public Denomination setId(Integer value) { this.id = value; return this; }
        public String getCode() { return code; }
        public Denomination setCode(String value) { this.code = value; return this; }
        public String getDenominationName() { return denomination_name; }
        public Denomination setDenominationName(String value) { this.denomination_name = value; return this; }
    }

    public static class Occupation
    {
        public Integer id = null;
        public String code = null;
        public String occupation_name = null;
        
        public Integer getId() { return id; }
        public Occupation setId(Integer value) { this.id = value; return this; }
        public String getCode() { return code; }
        public Occupation setCode(String value) { this.code = value; return this; }
        public String getOccupationName() { return occupation_name; }
        public Occupation setOccupationName(String value) { this.occupation_name = value; return this; }
    }

    public static class Ethnicity
    {
        public Integer id = null;
        public String code = null;
        public String ethnicity_name = null;
        
        public Integer getId() { return id; }
        public Ethnicity setId(Integer value) { this.id = value; return this; }
        public String getCode() { return code; }
        public Ethnicity setCode(String value) { this.code = value; return this; }
        public String getEthnicityName() { return ethnicity_name; }
        public Ethnicity setEthnicityName(String value) { this.ethnicity_name = value; return this; }
    }

}

Java PersonBaseValuesRequest 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/baseValues HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PersonBaseValuesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PersonBaseValuesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <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>
  <countriesAndStates>
    <CountriesAndStatesResponse>
      <country_code>String</country_code>
      <country_name>String</country_name>
      <states xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </states>
    </CountriesAndStatesResponse>
  </countriesAndStates>
  <denominations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Denomination>
      <d2p1:code>String</d2p1:code>
      <d2p1:denomination_name>String</d2p1:denomination_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Denomination>
  </denominations>
  <ethnicities xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Ethnicity>
      <d2p1:code>String</d2p1:code>
      <d2p1:ethnicity_name>String</d2p1:ethnicity_name>
      <d2p1:id>0</d2p1:id>
    </d2p1:Ethnicity>
  </ethnicities>
  <maritalStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </maritalStatuses>
  <occupations xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.DatabaseModels.REGIS">
    <d2p1:Occupation>
      <d2p1:code>String</d2p1:code>
      <d2p1:id>0</d2p1:id>
      <d2p1:occupation_name>String</d2p1:occupation_name>
    </d2p1:Occupation>
  </occupations>
  <person>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <added_by>String</added_by>
    <added_date>0001-01-01T00:00:00</added_date>
    <addr1>String</addr1>
    <addr2>String</addr2>
    <addr_last_changed_by>String</addr_last_changed_by>
    <addr_last_changed_date>0001-01-01T00:00:00</addr_last_changed_date>
    <birth_name>String</birth_name>
    <citizenship>String</citizenship>
    <citizenship_other>String</citizenship_other>
    <city>String</city>
    <code>String</code>
    <country>String</country>
    <crm_assigned>String</crm_assigned>
    <crm_student_status>String</crm_student_status>
    <deceased_date>0001-01-01T00:00:00</deceased_date>
    <denomination>String</denomination>
    <dob>0001-01-01T00:00:00</dob>
    <email>String</email>
    <ethnicity>String</ethnicity>
    <first_name>String</first_name>
    <gender>String</gender>
    <include_on_website>false</include_on_website>
    <is_donor>false</is_donor>
    <is_gp_customer>false</is_gp_customer>
    <is_regent_staff>false</is_regent_staff>
    <is_vendor>false</is_vendor>
    <last_changed_by>String</last_changed_by>
    <last_changed_date>0001-01-01T00:00:00</last_changed_date>
    <last_name>String</last_name>
    <last_registered_term>String</last_registered_term>
    <marital_status>String</marital_status>
    <middle_name>String</middle_name>
    <occupation>String</occupation>
    <override_transcript_name>String</override_transcript_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>
    <prefix>String</prefix>
    <regent_current_program>String</regent_current_program>
    <regent_degrees>String</regent_degrees>
    <regent_department>String</regent_department>
    <regent_faculty_profile_url>String</regent_faculty_profile_url>
    <regent_id>0</regent_id>
    <regent_image_url>String</regent_image_url>
    <regent_login>String</regent_login>
    <regent_title>String</regent_title>
    <spouse_name>String</spouse_name>
    <spouse_regent_id>0</spouse_regent_id>
    <spouse_rwl>String</spouse_rwl>
    <state>String</state>
    <tax_number>String</tax_number>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </person>
  <prefixes>
    <PrefixResponse>
      <prefix_code>String</prefix_code>
      <prefix_name>String</prefix_name>
    </PrefixResponse>
  </prefixes>
</PersonBaseValuesResponse>