regis

<back to all web services

BioSyncRequest

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

public class dtos
{

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

    public static class BioSyncResponse
    {
        public ResponseStatus responseStatus = null;
        public String uuid = null;
        public Integer regent_id = null;
        public BioResponse sugar_bio = null;
        public BioResponse regis_bio = null;
        public BioResponse re_bio = null;
        public Boolean exists_in_sugar = null;
        public Boolean exists_in_re = null;
        public Boolean are_equal = null;
        public Boolean first_name_are_equal = null;
        public Boolean middle_name_are_equal = null;
        public Boolean last_name_are_equal = null;
        public Boolean preferred_name_are_equal = null;
        public Boolean birth_name_are_equal = null;
        public Boolean prefix_are_equal = null;
        public Boolean dob_are_equal = null;
        public Boolean deceased_are_equal = null;
        public Boolean citizenship_are_equal = null;
        public Boolean gender_are_equal = null;
        public Boolean marital_status_are_equal = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public BioSyncResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getUuid() { return uuid; }
        public BioSyncResponse setUuid(String value) { this.uuid = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public BioSyncResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public BioResponse getSugarBio() { return sugar_bio; }
        public BioSyncResponse setSugarBio(BioResponse value) { this.sugar_bio = value; return this; }
        public BioResponse getRegisBio() { return regis_bio; }
        public BioSyncResponse setRegisBio(BioResponse value) { this.regis_bio = value; return this; }
        public BioResponse getReBio() { return re_bio; }
        public BioSyncResponse setReBio(BioResponse value) { this.re_bio = value; return this; }
        public Boolean isExistsInSugar() { return exists_in_sugar; }
        public BioSyncResponse setExistsInSugar(Boolean value) { this.exists_in_sugar = value; return this; }
        public Boolean isExistsInRe() { return exists_in_re; }
        public BioSyncResponse setExistsInRe(Boolean value) { this.exists_in_re = value; return this; }
        public Boolean isAreEqual() { return are_equal; }
        public BioSyncResponse setAreEqual(Boolean value) { this.are_equal = value; return this; }
        public Boolean isFirstNameAreEqual() { return first_name_are_equal; }
        public BioSyncResponse setFirstNameAreEqual(Boolean value) { this.first_name_are_equal = value; return this; }
        public Boolean isMiddleNameAreEqual() { return middle_name_are_equal; }
        public BioSyncResponse setMiddleNameAreEqual(Boolean value) { this.middle_name_are_equal = value; return this; }
        public Boolean isLastNameAreEqual() { return last_name_are_equal; }
        public BioSyncResponse setLastNameAreEqual(Boolean value) { this.last_name_are_equal = value; return this; }
        public Boolean isPreferredNameAreEqual() { return preferred_name_are_equal; }
        public BioSyncResponse setPreferredNameAreEqual(Boolean value) { this.preferred_name_are_equal = value; return this; }
        public Boolean isBirthNameAreEqual() { return birth_name_are_equal; }
        public BioSyncResponse setBirthNameAreEqual(Boolean value) { this.birth_name_are_equal = value; return this; }
        public Boolean isPrefixAreEqual() { return prefix_are_equal; }
        public BioSyncResponse setPrefixAreEqual(Boolean value) { this.prefix_are_equal = value; return this; }
        public Boolean isDobAreEqual() { return dob_are_equal; }
        public BioSyncResponse setDobAreEqual(Boolean value) { this.dob_are_equal = value; return this; }
        public Boolean isDeceasedAreEqual() { return deceased_are_equal; }
        public BioSyncResponse setDeceasedAreEqual(Boolean value) { this.deceased_are_equal = value; return this; }
        public Boolean isCitizenshipAreEqual() { return citizenship_are_equal; }
        public BioSyncResponse setCitizenshipAreEqual(Boolean value) { this.citizenship_are_equal = value; return this; }
        public Boolean isGenderAreEqual() { return gender_are_equal; }
        public BioSyncResponse setGenderAreEqual(Boolean value) { this.gender_are_equal = value; return this; }
        public Boolean isMaritalStatusAreEqual() { return marital_status_are_equal; }
        public BioSyncResponse setMaritalStatusAreEqual(Boolean value) { this.marital_status_are_equal = 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 BioSyncRequest 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/sync HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<BioSyncResponse 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>
  <are_equal>false</are_equal>
  <birth_name_are_equal>false</birth_name_are_equal>
  <citizenship_are_equal>false</citizenship_are_equal>
  <deceased_are_equal>false</deceased_are_equal>
  <dob_are_equal>false</dob_are_equal>
  <exists_in_re>false</exists_in_re>
  <exists_in_sugar>false</exists_in_sugar>
  <first_name_are_equal>false</first_name_are_equal>
  <gender_are_equal>false</gender_are_equal>
  <last_name_are_equal>false</last_name_are_equal>
  <marital_status_are_equal>false</marital_status_are_equal>
  <middle_name_are_equal>false</middle_name_are_equal>
  <preferred_name_are_equal>false</preferred_name_are_equal>
  <prefix_are_equal>false</prefix_are_equal>
  <re_bio>
    <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>
    <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>
  </re_bio>
  <regent_id>0</regent_id>
  <regis_bio>
    <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>
    <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>
  </regis_bio>
  <sugar_bio>
    <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>
    <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>
  </sugar_bio>
  <uuid>String</uuid>
</BioSyncResponse>