regis

<back to all web services

ExternalDegreeAuthorizeDynamicsRequest

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

public class dtos
{

    public static class ExternalDegreeAuthorizeDynamicsRequest
    {
        public String uuid = null;
        public String authorizing_uuid = null;
        
        public String getUuid() { return uuid; }
        public ExternalDegreeAuthorizeDynamicsRequest setUuid(String value) { this.uuid = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public ExternalDegreeAuthorizeDynamicsRequest setAuthorizingUuid(String value) { this.authorizing_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 ExternalDegreeAuthorizeDynamicsRequest 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 /Academic/ExternalDegree/AuthorizeDynamics/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ExternalDegreesResponse 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>
  <degrees>
    <ExternalDegreeResponse>
      <degree_name>String</degree_name>
      <degree_override_name>String</degree_override_name>
      <end_year>0</end_year>
      <graduation_month>String</graduation_month>
      <id>0</id>
      <institution_id>0</institution_id>
      <institution_name>String</institution_name>
      <is_only_in_d365>false</is_only_in_d365>
      <start_year>0</start_year>
    </ExternalDegreeResponse>
  </degrees>
  <gpa>0</gpa>
  <person>
    <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>
    <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>
    <is_faculty>false</is_faculty>
    <is_student>false</is_student>
    <is_vendor>false</is_vendor>
    <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>
    <regent_id>0</regent_id>
    <regent_login>String</regent_login>
    <state>String</state>
    <ubc_id>0</ubc_id>
    <uuid>String</uuid>
  </person>
  <student_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>
  </student_programs>
  <valid_degrees>
    <ExternalDegreesAdminResponse>
      <degree_code>String</degree_code>
      <degree_name>String</degree_name>
      <degree_type>String</degree_type>
    </ExternalDegreesAdminResponse>
  </valid_degrees>
</ExternalDegreesResponse>