| Required role: | REGISUserRole |
| POST | /person/{uuid}/sidebar |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class PersonSideBarRequest
{
public String uuid = null;
public String getUuid() { return uuid; }
public PersonSideBarRequest setUuid(String value) { this.uuid = value; return this; }
}
public static class PersonSideBarResponse
{
public ResponseStatus responseStatus = null;
public Integer regent_id = null;
public Integer ubc_id = null;
public String regent_login = null;
public String uuid = null;
public String first_name = null;
public String middle_name = null;
public String last_name = null;
public String preferred_name = null;
public Date dob = null;
public String citizenship = null;
public String citizenship_other = null;
public String permanent_resident = null;
public String addr1 = null;
public String addr2 = null;
public String city = null;
public String state = null;
public String code = null;
public String country = null;
public String email = null;
public String phone_home = null;
public String phone_cell = null;
public String phone_bus = null;
public String imageBase64 = null;
public String tax_number = null;
public ArrayList<StudentProgramSimpleResponse> programs = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public PersonSideBarResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRegentId() { return regent_id; }
public PersonSideBarResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public Integer getUbcId() { return ubc_id; }
public PersonSideBarResponse setUbcId(Integer value) { this.ubc_id = value; return this; }
public String getRegentLogin() { return regent_login; }
public PersonSideBarResponse setRegentLogin(String value) { this.regent_login = value; return this; }
public String getUuid() { return uuid; }
public PersonSideBarResponse setUuid(String value) { this.uuid = value; return this; }
public String getFirstName() { return first_name; }
public PersonSideBarResponse setFirstName(String value) { this.first_name = value; return this; }
public String getMiddleName() { return middle_name; }
public PersonSideBarResponse setMiddleName(String value) { this.middle_name = value; return this; }
public String getLastName() { return last_name; }
public PersonSideBarResponse setLastName(String value) { this.last_name = value; return this; }
public String getPreferredName() { return preferred_name; }
public PersonSideBarResponse setPreferredName(String value) { this.preferred_name = value; return this; }
public Date getDob() { return dob; }
public PersonSideBarResponse setDob(Date value) { this.dob = value; return this; }
public String getCitizenship() { return citizenship; }
public PersonSideBarResponse setCitizenship(String value) { this.citizenship = value; return this; }
public String getCitizenshipOther() { return citizenship_other; }
public PersonSideBarResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
public String getPermanentResident() { return permanent_resident; }
public PersonSideBarResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
public String getAddr1() { return addr1; }
public PersonSideBarResponse setAddr1(String value) { this.addr1 = value; return this; }
public String getAddr2() { return addr2; }
public PersonSideBarResponse setAddr2(String value) { this.addr2 = value; return this; }
public String getCity() { return city; }
public PersonSideBarResponse setCity(String value) { this.city = value; return this; }
public String getState() { return state; }
public PersonSideBarResponse setState(String value) { this.state = value; return this; }
public String getCode() { return code; }
public PersonSideBarResponse setCode(String value) { this.code = value; return this; }
public String getCountry() { return country; }
public PersonSideBarResponse setCountry(String value) { this.country = value; return this; }
public String getEmail() { return email; }
public PersonSideBarResponse setEmail(String value) { this.email = value; return this; }
public String getPhoneHome() { return phone_home; }
public PersonSideBarResponse setPhoneHome(String value) { this.phone_home = value; return this; }
public String getPhoneCell() { return phone_cell; }
public PersonSideBarResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
public String getPhoneBus() { return phone_bus; }
public PersonSideBarResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
public String getImageBase64() { return imageBase64; }
public PersonSideBarResponse setImageBase64(String value) { this.imageBase64 = value; return this; }
public String getTaxNumber() { return tax_number; }
public PersonSideBarResponse setTaxNumber(String value) { this.tax_number = value; return this; }
public ArrayList<StudentProgramSimpleResponse> getPrograms() { return programs; }
public PersonSideBarResponse setPrograms(ArrayList<StudentProgramSimpleResponse> value) { this.programs = value; return this; }
}
public static class StudentProgramSimpleResponse
{
public ResponseStatus responseStatus = null;
public Integer regent_id = null;
public String uuid = null;
public Integer program_id = null;
public String program_code = null;
public String program_name = null;
public String concentration_code = null;
public String concentration_name = null;
public Date start_date = null;
public Date end_date = null;
public String catalog = null;
public Boolean is_active = null;
public Boolean is_graduated = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public StudentProgramSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRegentId() { return regent_id; }
public StudentProgramSimpleResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getUuid() { return uuid; }
public StudentProgramSimpleResponse setUuid(String value) { this.uuid = value; return this; }
public Integer getProgramId() { return program_id; }
public StudentProgramSimpleResponse setProgramId(Integer value) { this.program_id = value; return this; }
public String getProgramCode() { return program_code; }
public StudentProgramSimpleResponse setProgramCode(String value) { this.program_code = value; return this; }
public String getProgramName() { return program_name; }
public StudentProgramSimpleResponse setProgramName(String value) { this.program_name = value; return this; }
public String getConcentrationCode() { return concentration_code; }
public StudentProgramSimpleResponse setConcentrationCode(String value) { this.concentration_code = value; return this; }
public String getConcentrationName() { return concentration_name; }
public StudentProgramSimpleResponse setConcentrationName(String value) { this.concentration_name = value; return this; }
public Date getStartDate() { return start_date; }
public StudentProgramSimpleResponse setStartDate(Date value) { this.start_date = value; return this; }
public Date getEndDate() { return end_date; }
public StudentProgramSimpleResponse setEndDate(Date value) { this.end_date = value; return this; }
public String getCatalog() { return catalog; }
public StudentProgramSimpleResponse setCatalog(String value) { this.catalog = value; return this; }
public Boolean getIsActive() { return is_active; }
public StudentProgramSimpleResponse setIsActive(Boolean value) { this.is_active = value; return this; }
public Boolean getIsGraduated() { return is_graduated; }
public StudentProgramSimpleResponse setIsGraduated(Boolean value) { this.is_graduated = value; return this; }
}
}
Java PersonSideBarRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /person/{uuid}/sidebar HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PersonSideBarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</PersonSideBarRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PersonSideBarResponse 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>
<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>
<imageBase64>String</imageBase64>
<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>
<programs>
<StudentProgramSimpleResponse>
<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>
<catalog>String</catalog>
<concentration_code>String</concentration_code>
<concentration_name>String</concentration_name>
<end_date>0001-01-01T00:00:00</end_date>
<is_active>false</is_active>
<is_graduated>false</is_graduated>
<program_code>String</program_code>
<program_id>0</program_id>
<program_name>String</program_name>
<regent_id>0</regent_id>
<start_date>0001-01-01T00:00:00</start_date>
<uuid>String</uuid>
</StudentProgramSimpleResponse>
</programs>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
<state>String</state>
<tax_number>String</tax_number>
<ubc_id>0</ubc_id>
<uuid>String</uuid>
</PersonSideBarResponse>