| Required permission: | ReadRegistrationAvailability |
| POST | /registration/summary |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
public static class RegistrationSummaryRequest
{
public String uuid = null;
public String from_this_term = null;
public String getUuid() { return uuid; }
public RegistrationSummaryRequest setUuid(String value) { this.uuid = value; return this; }
public String getFromThisTerm() { return from_this_term; }
public RegistrationSummaryRequest setFromThisTerm(String value) { this.from_this_term = value; return this; }
}
public static class RegistrationSummaryResponse
{
public ResponseStatus responseStatus = null;
public Integer regent_id = null;
public String uuid = null;
public Boolean is_missing_tax_number = null;
public PersonSimpleResponse person = null;
public ArrayList<StudentAcademicCredentialByReportingTermSimpleResponse> registrations = null;
public ProvisionalRegistrationsForStudentResponse provisional_registrations = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public RegistrationSummaryResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRegentId() { return regent_id; }
public RegistrationSummaryResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getUuid() { return uuid; }
public RegistrationSummaryResponse setUuid(String value) { this.uuid = value; return this; }
public Boolean getIsMissingTaxNumber() { return is_missing_tax_number; }
public RegistrationSummaryResponse setIsMissingTaxNumber(Boolean value) { this.is_missing_tax_number = value; return this; }
public PersonSimpleResponse getPerson() { return person; }
public RegistrationSummaryResponse setPerson(PersonSimpleResponse value) { this.person = value; return this; }
public ArrayList<StudentAcademicCredentialByReportingTermSimpleResponse> getRegistrations() { return registrations; }
public RegistrationSummaryResponse setRegistrations(ArrayList<StudentAcademicCredentialByReportingTermSimpleResponse> value) { this.registrations = value; return this; }
public ProvisionalRegistrationsForStudentResponse getProvisionalRegistrations() { return provisional_registrations; }
public RegistrationSummaryResponse setProvisionalRegistrations(ProvisionalRegistrationsForStudentResponse value) { this.provisional_registrations = value; return this; }
}
public static class PersonSimpleResponse
{
public ResponseStatus responseStatus = null;
public Integer regent_id = null;
public Integer ubc_id = null;
public String uuid = null;
public String regent_login = null;
public String first_name = null;
public String preferred_name = null;
public String middle_name = null;
public String last_name = null;
public String email = null;
public String phone_home = null;
public String phone_cell = null;
public String phone_bus = null;
public String addr1 = null;
public String addr2 = null;
public String city = null;
public String state = null;
public String country = null;
public String code = null;
public String citizenship = null;
public String citizenship_other = null;
public String permanent_resident = null;
public Date dob = null;
public Boolean is_student = null;
public Boolean is_faculty = null;
public Boolean is_vendor = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public PersonSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRegentId() { return regent_id; }
public PersonSimpleResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public Integer getUbcId() { return ubc_id; }
public PersonSimpleResponse setUbcId(Integer value) { this.ubc_id = value; return this; }
public String getUuid() { return uuid; }
public PersonSimpleResponse setUuid(String value) { this.uuid = value; return this; }
public String getRegentLogin() { return regent_login; }
public PersonSimpleResponse setRegentLogin(String value) { this.regent_login = value; return this; }
public String getFirstName() { return first_name; }
public PersonSimpleResponse setFirstName(String value) { this.first_name = value; return this; }
public String getPreferredName() { return preferred_name; }
public PersonSimpleResponse setPreferredName(String value) { this.preferred_name = value; return this; }
public String getMiddleName() { return middle_name; }
public PersonSimpleResponse setMiddleName(String value) { this.middle_name = value; return this; }
public String getLastName() { return last_name; }
public PersonSimpleResponse setLastName(String value) { this.last_name = value; return this; }
public String getEmail() { return email; }
public PersonSimpleResponse setEmail(String value) { this.email = value; return this; }
public String getPhoneHome() { return phone_home; }
public PersonSimpleResponse setPhoneHome(String value) { this.phone_home = value; return this; }
public String getPhoneCell() { return phone_cell; }
public PersonSimpleResponse setPhoneCell(String value) { this.phone_cell = value; return this; }
public String getPhoneBus() { return phone_bus; }
public PersonSimpleResponse setPhoneBus(String value) { this.phone_bus = value; return this; }
public String getAddr1() { return addr1; }
public PersonSimpleResponse setAddr1(String value) { this.addr1 = value; return this; }
public String getAddr2() { return addr2; }
public PersonSimpleResponse setAddr2(String value) { this.addr2 = value; return this; }
public String getCity() { return city; }
public PersonSimpleResponse setCity(String value) { this.city = value; return this; }
public String getState() { return state; }
public PersonSimpleResponse setState(String value) { this.state = value; return this; }
public String getCountry() { return country; }
public PersonSimpleResponse setCountry(String value) { this.country = value; return this; }
public String getCode() { return code; }
public PersonSimpleResponse setCode(String value) { this.code = value; return this; }
public String getCitizenship() { return citizenship; }
public PersonSimpleResponse setCitizenship(String value) { this.citizenship = value; return this; }
public String getCitizenshipOther() { return citizenship_other; }
public PersonSimpleResponse setCitizenshipOther(String value) { this.citizenship_other = value; return this; }
public String getPermanentResident() { return permanent_resident; }
public PersonSimpleResponse setPermanentResident(String value) { this.permanent_resident = value; return this; }
public Date getDob() { return dob; }
public PersonSimpleResponse setDob(Date value) { this.dob = value; return this; }
public Boolean getIsStudent() { return is_student; }
public PersonSimpleResponse setIsStudent(Boolean value) { this.is_student = value; return this; }
public Boolean getIsFaculty() { return is_faculty; }
public PersonSimpleResponse setIsFaculty(Boolean value) { this.is_faculty = value; return this; }
public Boolean getIsVendor() { return is_vendor; }
public PersonSimpleResponse setIsVendor(Boolean value) { this.is_vendor = value; return this; }
}
public static class StudentAcademicCredentialByReportingTermSimpleResponse
{
public ResponseStatus responseStatus = null;
public String reportingTerm = null;
public BigDecimal onlineCreditsAttempted = null;
public BigDecimal onlineAuditsAttempted = null;
public ArrayList<StudentAcademicCredentialSimpleResponse> studentAcademicCredentialSimpleResponse = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public StudentAcademicCredentialByReportingTermSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public String getReportingTerm() { return reportingTerm; }
public StudentAcademicCredentialByReportingTermSimpleResponse setReportingTerm(String value) { this.reportingTerm = value; return this; }
public BigDecimal getOnlineCreditsAttempted() { return onlineCreditsAttempted; }
public StudentAcademicCredentialByReportingTermSimpleResponse setOnlineCreditsAttempted(BigDecimal value) { this.onlineCreditsAttempted = value; return this; }
public BigDecimal getOnlineAuditsAttempted() { return onlineAuditsAttempted; }
public StudentAcademicCredentialByReportingTermSimpleResponse setOnlineAuditsAttempted(BigDecimal value) { this.onlineAuditsAttempted = value; return this; }
public ArrayList<StudentAcademicCredentialSimpleResponse> getStudentAcademicCredentialSimpleResponse() { return studentAcademicCredentialSimpleResponse; }
public StudentAcademicCredentialByReportingTermSimpleResponse setStudentAcademicCredentialSimpleResponse(ArrayList<StudentAcademicCredentialSimpleResponse> value) { this.studentAcademicCredentialSimpleResponse = value; return this; }
}
public static class StudentAcademicCredentialSimpleResponse
{
public ResponseStatus responseStatus = null;
public String course_uuid = null;
public String course_name = null;
public String section_code = null;
public Integer section_id = null;
public String term = null;
public String reporting_term = null;
public String title = null;
public BigDecimal amount = null;
public Boolean is_audit = null;
public Boolean is_pass_fail = null;
public Boolean is_graded = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public StudentAcademicCredentialSimpleResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public String getCourseUuid() { return course_uuid; }
public StudentAcademicCredentialSimpleResponse setCourseUuid(String value) { this.course_uuid = value; return this; }
public String getCourseName() { return course_name; }
public StudentAcademicCredentialSimpleResponse setCourseName(String value) { this.course_name = value; return this; }
public String getSectionCode() { return section_code; }
public StudentAcademicCredentialSimpleResponse setSectionCode(String value) { this.section_code = value; return this; }
public Integer getSectionId() { return section_id; }
public StudentAcademicCredentialSimpleResponse setSectionId(Integer value) { this.section_id = value; return this; }
public String getTerm() { return term; }
public StudentAcademicCredentialSimpleResponse setTerm(String value) { this.term = value; return this; }
public String getReportingTerm() { return reporting_term; }
public StudentAcademicCredentialSimpleResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
public String getTitle() { return title; }
public StudentAcademicCredentialSimpleResponse setTitle(String value) { this.title = value; return this; }
public BigDecimal getAmount() { return amount; }
public StudentAcademicCredentialSimpleResponse setAmount(BigDecimal value) { this.amount = value; return this; }
public Boolean getIsAudit() { return is_audit; }
public StudentAcademicCredentialSimpleResponse setIsAudit(Boolean value) { this.is_audit = value; return this; }
public Boolean getIsPassFail() { return is_pass_fail; }
public StudentAcademicCredentialSimpleResponse setIsPassFail(Boolean value) { this.is_pass_fail = value; return this; }
public Boolean getIsGraded() { return is_graded; }
public StudentAcademicCredentialSimpleResponse setIsGraded(Boolean value) { this.is_graded = value; return this; }
}
public static class ProvisionalRegistrationsForStudentResponse
{
public ResponseStatus responseStatus = null;
public Integer regent_id = null;
public String uuid = null;
public ArrayList<ProvisionalRegistrationResponse> provisional_registrations = null;
public ResponseStatus getResponseStatus() { return responseStatus; }
public ProvisionalRegistrationsForStudentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
public Integer getRegentId() { return regent_id; }
public ProvisionalRegistrationsForStudentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getUuid() { return uuid; }
public ProvisionalRegistrationsForStudentResponse setUuid(String value) { this.uuid = value; return this; }
public ArrayList<ProvisionalRegistrationResponse> getProvisionalRegistrations() { return provisional_registrations; }
public ProvisionalRegistrationsForStudentResponse setProvisionalRegistrations(ArrayList<ProvisionalRegistrationResponse> value) { this.provisional_registrations = value; return this; }
}
public static class ProvisionalRegistrationResponse
{
public String uuid = null;
public Integer regent_id = null;
public String student_name = null;
public String email = null;
public String section_uuid = null;
public String student_section_uuid = null;
public String course_name = null;
public String section_code = null;
public String title = null;
public String term = null;
public BigDecimal amount = null;
public Boolean is_audit = null;
public Boolean is_waitlist = null;
public Boolean is_missing_requisites = null;
public Boolean is_other_restriction = null;
public ArrayList<RegistrationDocumentResponse> documents = null;
public Date requested_date = null;
public String getUuid() { return uuid; }
public ProvisionalRegistrationResponse setUuid(String value) { this.uuid = value; return this; }
public Integer getRegentId() { return regent_id; }
public ProvisionalRegistrationResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getStudentName() { return student_name; }
public ProvisionalRegistrationResponse setStudentName(String value) { this.student_name = value; return this; }
public String getEmail() { return email; }
public ProvisionalRegistrationResponse setEmail(String value) { this.email = value; return this; }
public String getSectionUuid() { return section_uuid; }
public ProvisionalRegistrationResponse setSectionUuid(String value) { this.section_uuid = value; return this; }
public String getStudentSectionUuid() { return student_section_uuid; }
public ProvisionalRegistrationResponse setStudentSectionUuid(String value) { this.student_section_uuid = value; return this; }
public String getCourseName() { return course_name; }
public ProvisionalRegistrationResponse setCourseName(String value) { this.course_name = value; return this; }
public String getSectionCode() { return section_code; }
public ProvisionalRegistrationResponse setSectionCode(String value) { this.section_code = value; return this; }
public String getTitle() { return title; }
public ProvisionalRegistrationResponse setTitle(String value) { this.title = value; return this; }
public String getTerm() { return term; }
public ProvisionalRegistrationResponse setTerm(String value) { this.term = value; return this; }
public BigDecimal getAmount() { return amount; }
public ProvisionalRegistrationResponse setAmount(BigDecimal value) { this.amount = value; return this; }
public Boolean getIsAudit() { return is_audit; }
public ProvisionalRegistrationResponse setIsAudit(Boolean value) { this.is_audit = value; return this; }
public Boolean getIsWaitlist() { return is_waitlist; }
public ProvisionalRegistrationResponse setIsWaitlist(Boolean value) { this.is_waitlist = value; return this; }
public Boolean getIsMissingRequisites() { return is_missing_requisites; }
public ProvisionalRegistrationResponse setIsMissingRequisites(Boolean value) { this.is_missing_requisites = value; return this; }
public Boolean getIsOtherRestriction() { return is_other_restriction; }
public ProvisionalRegistrationResponse setIsOtherRestriction(Boolean value) { this.is_other_restriction = value; return this; }
public ArrayList<RegistrationDocumentResponse> getDocuments() { return documents; }
public ProvisionalRegistrationResponse setDocuments(ArrayList<RegistrationDocumentResponse> value) { this.documents = value; return this; }
public Date getRequestedDate() { return requested_date; }
public ProvisionalRegistrationResponse setRequestedDate(Date value) { this.requested_date = value; return this; }
}
public static class RegistrationDocumentResponse
{
public String uuid = null;
public Integer regent_id = null;
public String first_name = null;
public String last_name = null;
public String gender = null;
public String email = null;
public String program = null;
public String concentration = null;
public String section_uuid = null;
public String course_name = null;
public String course_title = null;
public String reporting_term = null;
public String document_code = null;
public String document_json = null;
public String document_name = null;
public String document_description = null;
public Date added_date = null;
public Date changed_date = null;
public String getUuid() { return uuid; }
public RegistrationDocumentResponse setUuid(String value) { this.uuid = value; return this; }
public Integer getRegentId() { return regent_id; }
public RegistrationDocumentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
public String getFirstName() { return first_name; }
public RegistrationDocumentResponse setFirstName(String value) { this.first_name = value; return this; }
public String getLastName() { return last_name; }
public RegistrationDocumentResponse setLastName(String value) { this.last_name = value; return this; }
public String getGender() { return gender; }
public RegistrationDocumentResponse setGender(String value) { this.gender = value; return this; }
public String getEmail() { return email; }
public RegistrationDocumentResponse setEmail(String value) { this.email = value; return this; }
public String getProgram() { return program; }
public RegistrationDocumentResponse setProgram(String value) { this.program = value; return this; }
public String getConcentration() { return concentration; }
public RegistrationDocumentResponse setConcentration(String value) { this.concentration = value; return this; }
public String getSectionUuid() { return section_uuid; }
public RegistrationDocumentResponse setSectionUuid(String value) { this.section_uuid = value; return this; }
public String getCourseName() { return course_name; }
public RegistrationDocumentResponse setCourseName(String value) { this.course_name = value; return this; }
public String getCourseTitle() { return course_title; }
public RegistrationDocumentResponse setCourseTitle(String value) { this.course_title = value; return this; }
public String getReportingTerm() { return reporting_term; }
public RegistrationDocumentResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
public String getDocumentCode() { return document_code; }
public RegistrationDocumentResponse setDocumentCode(String value) { this.document_code = value; return this; }
public String getDocumentJson() { return document_json; }
public RegistrationDocumentResponse setDocumentJson(String value) { this.document_json = value; return this; }
public String getDocumentName() { return document_name; }
public RegistrationDocumentResponse setDocumentName(String value) { this.document_name = value; return this; }
public String getDocumentDescription() { return document_description; }
public RegistrationDocumentResponse setDocumentDescription(String value) { this.document_description = value; return this; }
public Date getAddedDate() { return added_date; }
public RegistrationDocumentResponse setAddedDate(Date value) { this.added_date = value; return this; }
public Date getChangedDate() { return changed_date; }
public RegistrationDocumentResponse setChangedDate(Date value) { this.changed_date = value; return this; }
}
}
Java RegistrationSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /registration/summary HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String,
from_this_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
uuid: String,
is_missing_tax_number: False,
person:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
ubc_id: 0,
uuid: String,
regent_login: String,
first_name: String,
preferred_name: String,
middle_name: String,
last_name: String,
email: String,
phone_home: String,
phone_cell: String,
phone_bus: String,
addr1: String,
addr2: String,
city: String,
state: String,
country: String,
code: String,
citizenship: String,
citizenship_other: String,
permanent_resident: String,
dob: 0001-01-01,
is_student: False,
is_faculty: False,
is_vendor: False
},
registrations:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
reportingTerm: String,
onlineCreditsAttempted: 0,
onlineAuditsAttempted: 0,
studentAcademicCredentialSimpleResponse:
[
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
course_uuid: String,
course_name: String,
section_code: String,
section_id: 0,
term: String,
reporting_term: String,
title: String,
amount: 0,
is_audit: False,
is_pass_fail: False,
is_graded: False
}
]
}
],
provisional_registrations:
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
regent_id: 0,
uuid: String,
provisional_registrations:
[
{
uuid: String,
regent_id: 0,
student_name: String,
email: String,
section_uuid: String,
student_section_uuid: String,
course_name: String,
section_code: String,
title: String,
term: String,
amount: 0,
is_audit: False,
is_waitlist: False,
is_missing_requisites: False,
is_other_restriction: False,
documents:
[
{
uuid: String,
regent_id: 0,
first_name: String,
last_name: String,
gender: String,
email: String,
program: String,
concentration: String,
section_uuid: String,
course_name: String,
course_title: String,
reporting_term: String,
document_code: String,
document_json: String,
document_name: String,
document_description: String,
added_date: 0001-01-01,
changed_date: 0001-01-01
}
],
requested_date: 0001-01-01
}
]
}
}