regis

<back to all web services

BioHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/history
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class BioHistoryRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public BioHistoryRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class BioHistoryResponse
    {
        public ResponseStatus responseStatus = null;
        public String uuid = null;
        public Integer regent_id = null;
        public ArrayList<BioResponse> bios = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BioHistoryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getUuid() { return uuid; }
        public BioHistoryResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public BioHistoryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public ArrayList<BioResponse> getBios() { return bios; }
        public BioHistoryResponse setBios(ArrayList<BioResponse> value) { this.bios = value; return this; }
    }

    public static class BioResponse
    {
        public ResponseStatus responseStatus = 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 prefix = null;
        public Date dob = null;
        public String citizenship = null;
        public String citizenship_code = null;
        public String citizenship_other = null;
        public String permanent_resident = null;
        public String citizenship_other_code = null;
        public String permanent_resident_code = null;
        public String gender = null;
        public String gender_code = null;
        public String marital_status = null;
        public String marital_status_code = null;
        public Date deceased_date = null;
        public String added_by = null;
        public Date added_date = null;
        public String changed_by = null;
        public Date changed_date = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BioResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getFirstName() { return first_name; }
        public BioResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public BioResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getLastName() { return last_name; }
        public BioResponse setLastName(String value) { this.last_name = value; return this; }
        public String getPreferredName() { return preferred_name; }
        public BioResponse setPreferredName(String value) { this.preferred_name = value; return this; }
        public String getBirthName() { return birth_name; }
        public BioResponse setBirthName(String value) { this.birth_name = value; return this; }
        public String getPrefix() { return prefix; }
        public BioResponse setPrefix(String value) { this.prefix = value; return this; }
        public Date getDob() { return dob; }
        public BioResponse setDob(Date value) { this.dob = value; return this; }
        public String getCitizenship() { return citizenship; }
        public BioResponse setCitizenship(String value) { this.citizenship = value; return this; }
        public String getCitizenshipCode() { return citizenship_code; }
        public BioResponse setCitizenshipCode(String value) { this.citizenship_code = value; return this; }
        public String getCitizenshipOther() { return citizenship_other; }
        public BioResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
        public String getPermanentResident() { return permanent_resident; }
        public BioResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
        public String getCitizenshipOtherCode() { return citizenship_other_code; }
        public BioResponse setCitizenshipOtherCode(String value) { this.citizenship_other_code = value; return this; }
        public String getPermanentResidentCode() { return permanent_resident_code; }
        public BioResponse setPermanentResidentCode(String value) { this.permanent_resident_code = value; return this; }
        public String getGender() { return gender; }
        public BioResponse setGender(String value) { this.gender = value; return this; }
        public String getGenderCode() { return gender_code; }
        public BioResponse setGenderCode(String value) { this.gender_code = value; return this; }
        public String getMaritalStatus() { return marital_status; }
        public BioResponse setMaritalStatus(String value) { this.marital_status = value; return this; }
        public String getMaritalStatusCode() { return marital_status_code; }
        public BioResponse setMaritalStatusCode(String value) { this.marital_status_code = value; return this; }
        public Date getDeceasedDate() { return deceased_date; }
        public BioResponse setDeceasedDate(Date value) { this.deceased_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public BioResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public BioResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public BioResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public BioResponse setChangedDate(Date value) { this.changed_date = value; return this; }
    }

}

Java BioHistoryRequest 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 /admissions/{uuid}/bio/history HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<BioHistoryResponse 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>
  <bios>
    <BioResponse>
      <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>
      <added_by>String</added_by>
      <added_date>0001-01-01T00:00:00</added_date>
      <birth_name>String</birth_name>
      <changed_by>String</changed_by>
      <changed_date>0001-01-01T00:00:00</changed_date>
      <citizenship>String</citizenship>
      <citizenship_code>String</citizenship_code>
      <citizenship_other>String</citizenship_other>
      <citizenship_other_code>String</citizenship_other_code>
      <deceased_date>0001-01-01T00:00:00</deceased_date>
      <dob>0001-01-01T00:00:00</dob>
      <first_name>String</first_name>
      <gender>String</gender>
      <gender_code>String</gender_code>
      <last_name>String</last_name>
      <marital_status>String</marital_status>
      <marital_status_code>String</marital_status_code>
      <middle_name>String</middle_name>
      <permanent_resident>String</permanent_resident>
      <permanent_resident_code>String</permanent_resident_code>
      <preferred_name>String</preferred_name>
      <prefix>String</prefix>
    </BioResponse>
  </bios>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</BioHistoryResponse>