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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"sugar_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"regis_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"re_bio":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"first_name":"String","middle_name":"String","last_name":"String","preferred_name":"String","birth_name":"String","prefix":"String","dob":"0001-01-01T00:00:00.0000000","citizenship":"String","citizenship_code":"String","citizenship_other":"String","permanent_resident":"String","citizenship_other_code":"String","permanent_resident_code":"String","gender":"String","gender_code":"String","marital_status":"String","marital_status_code":"String","deceased_date":"0001-01-01T00:00:00.0000000","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"},"exists_in_sugar":false,"exists_in_re":false,"are_equal":false,"first_name_are_equal":false,"middle_name_are_equal":false,"last_name_are_equal":false,"preferred_name_are_equal":false,"birth_name_are_equal":false,"prefix_are_equal":false,"dob_are_equal":false,"deceased_are_equal":false,"citizenship_are_equal":false,"gender_are_equal":false,"marital_status_are_equal":false}