regis

<back to all web services

ExternalDegreesRequest

Requires Authentication
Required permission:ReadExternalDegrees
The following routes are available for this service:
POST/Academic/{uuid}/ExternalDegrees
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

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

    public static class ExternalDegreesResponse
    {
        public ResponseStatus responseStatus = null;
        public PersonSimpleResponse person = null;
        public BigDecimal gpa = null;
        public ArrayList<StudentProgramSimpleResponse> student_programs = null;
        public ArrayList<ExternalDegreeResponse> degrees = null;
        public ArrayList<ExternalDegreesAdminResponse> valid_degrees = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ExternalDegreesResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public PersonSimpleResponse getPerson() { return person; }
        public ExternalDegreesResponse setPerson(PersonSimpleResponse value) { this.person = value; return this; }
        public BigDecimal getGpa() { return gpa; }
        public ExternalDegreesResponse setGpa(BigDecimal value) { this.gpa = value; return this; }
        public ArrayList<StudentProgramSimpleResponse> getStudentPrograms() { return student_programs; }
        public ExternalDegreesResponse setStudentPrograms(ArrayList<StudentProgramSimpleResponse> value) { this.student_programs = value; return this; }
        public ArrayList<ExternalDegreeResponse> getDegrees() { return degrees; }
        public ExternalDegreesResponse setDegrees(ArrayList<ExternalDegreeResponse> value) { this.degrees = value; return this; }
        public ArrayList<ExternalDegreesAdminResponse> getValidDegrees() { return valid_degrees; }
        public ExternalDegreesResponse setValidDegrees(ArrayList<ExternalDegreesAdminResponse> value) { this.valid_degrees = 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 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; }
    }

    public static class ExternalDegreeResponse
    {
        public Integer id = null;
        public Integer institution_id = null;
        public String degree_name = null;
        public String degree_override_name = null;
        public String institution_name = null;
        public String graduation_month = null;
        public Integer start_year = null;
        public Integer end_year = null;
        public Boolean is_only_in_d365 = null;
        
        public Integer getId() { return id; }
        public ExternalDegreeResponse setId(Integer value) { this.id = value; return this; }
        public Integer getInstitutionId() { return institution_id; }
        public ExternalDegreeResponse setInstitutionId(Integer value) { this.institution_id = value; return this; }
        public String getDegreeName() { return degree_name; }
        public ExternalDegreeResponse setDegreeName(String value) { this.degree_name = value; return this; }
        public String getDegreeOverrideName() { return degree_override_name; }
        public ExternalDegreeResponse setDegreeOverrideName(String value) { this.degree_override_name = value; return this; }
        public String getInstitutionName() { return institution_name; }
        public ExternalDegreeResponse setInstitutionName(String value) { this.institution_name = value; return this; }
        public String getGraduationMonth() { return graduation_month; }
        public ExternalDegreeResponse setGraduationMonth(String value) { this.graduation_month = value; return this; }
        public Integer getStartYear() { return start_year; }
        public ExternalDegreeResponse setStartYear(Integer value) { this.start_year = value; return this; }
        public Integer getEndYear() { return end_year; }
        public ExternalDegreeResponse setEndYear(Integer value) { this.end_year = value; return this; }
        public Boolean getIsOnlyInD365() { return is_only_in_d365; }
        public ExternalDegreeResponse setIsOnlyInD365(Boolean value) { this.is_only_in_d365 = value; return this; }
    }

    public static class ExternalDegreesAdminResponse
    {
        public String degree_code = null;
        public String degree_name = null;
        public String degree_type = null;
        
        public String getDegreeCode() { return degree_code; }
        public ExternalDegreesAdminResponse setDegreeCode(String value) { this.degree_code = value; return this; }
        public String getDegreeName() { return degree_name; }
        public ExternalDegreesAdminResponse setDegreeName(String value) { this.degree_name = value; return this; }
        public String getDegreeType() { return degree_type; }
        public ExternalDegreesAdminResponse setDegreeType(String value) { this.degree_type = value; return this; }
    }

}

Java ExternalDegreesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Academic/{uuid}/ExternalDegrees HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: 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
		}
	},
	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
	},
	gpa: 0,
	student_programs: 
	[
		{
			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,
			program_id: 0,
			program_code: String,
			program_name: String,
			concentration_code: String,
			concentration_name: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			catalog: String,
			is_active: False,
			is_graduated: False
		}
	],
	degrees: 
	[
		{
			id: 0,
			institution_id: 0,
			degree_name: String,
			degree_override_name: String,
			institution_name: String,
			graduation_month: String,
			start_year: 0,
			end_year: 0,
			is_only_in_d365: False
		}
	],
	valid_degrees: 
	[
		{
			degree_code: String,
			degree_name: String,
			degree_type: String
		}
	]
}