regis

<back to all web services

TranscriptRequest

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

public class dtos
{

    public static class TranscriptRequest
    {
        public String uuid = null;
        public String academic_level = null;
        public Boolean override_all_restrictions = null;
        public Boolean override_nonfinancial_restrictions = null;
        public String authorizing_uuid = null;
        
        public String getUuid() { return uuid; }
        public TranscriptRequest setUuid(String value) { this.uuid = value; return this; }
        public String getAcademicLevel() { return academic_level; }
        public TranscriptRequest setAcademicLevel(String value) { this.academic_level = value; return this; }
        public Boolean isOverrideAllRestrictions() { return override_all_restrictions; }
        public TranscriptRequest setOverrideAllRestrictions(Boolean value) { this.override_all_restrictions = value; return this; }
        public Boolean isOverrideNonfinancialRestrictions() { return override_nonfinancial_restrictions; }
        public TranscriptRequest setOverrideNonfinancialRestrictions(Boolean value) { this.override_nonfinancial_restrictions = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public TranscriptRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class TranscriptResponse
    {
        public ResponseStatus responseStatus = null;
        public String first_name = null;
        public String last_name = null;
        public String middle_name = null;
        public String override_name = null;
        public Integer regent_id = null;
        public String academic_level = null;
        public Date dob = null;
        public ArrayList<ExternalDegreeResponse> previous_degrees = null;
        public ArrayList<StudentProgramTranscriptResponse> student_programs = null;
        public ArrayList<RegentDegreeResponse> regent_degrees = null;
        public ArrayList<StudentAcademicCredentialTranscriptResponse> student_academic_credentials = null;
        public ArrayList<StudentTransferCredentialsTranscriptResponse> transfer_credentials = null;
        public ArrayList<String> transcript_notes = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public TranscriptResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getFirstName() { return first_name; }
        public TranscriptResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public TranscriptResponse setLastName(String value) { this.last_name = value; return this; }
        public String getMiddleName() { return middle_name; }
        public TranscriptResponse setMiddleName(String value) { this.middle_name = value; return this; }
        public String getOverrideName() { return override_name; }
        public TranscriptResponse setOverrideName(String value) { this.override_name = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public TranscriptResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getAcademicLevel() { return academic_level; }
        public TranscriptResponse setAcademicLevel(String value) { this.academic_level = value; return this; }
        public Date getDob() { return dob; }
        public TranscriptResponse setDob(Date value) { this.dob = value; return this; }
        public ArrayList<ExternalDegreeResponse> getPreviousDegrees() { return previous_degrees; }
        public TranscriptResponse setPreviousDegrees(ArrayList<ExternalDegreeResponse> value) { this.previous_degrees = value; return this; }
        public ArrayList<StudentProgramTranscriptResponse> getStudentPrograms() { return student_programs; }
        public TranscriptResponse setStudentPrograms(ArrayList<StudentProgramTranscriptResponse> value) { this.student_programs = value; return this; }
        public ArrayList<RegentDegreeResponse> getRegentDegrees() { return regent_degrees; }
        public TranscriptResponse setRegentDegrees(ArrayList<RegentDegreeResponse> value) { this.regent_degrees = value; return this; }
        public ArrayList<StudentAcademicCredentialTranscriptResponse> getStudentAcademicCredentials() { return student_academic_credentials; }
        public TranscriptResponse setStudentAcademicCredentials(ArrayList<StudentAcademicCredentialTranscriptResponse> value) { this.student_academic_credentials = value; return this; }
        public ArrayList<StudentTransferCredentialsTranscriptResponse> getTransferCredentials() { return transfer_credentials; }
        public TranscriptResponse setTransferCredentials(ArrayList<StudentTransferCredentialsTranscriptResponse> value) { this.transfer_credentials = value; return this; }
        public ArrayList<String> getTranscriptNotes() { return transcript_notes; }
        public TranscriptResponse setTranscriptNotes(ArrayList<String> value) { this.transcript_notes = 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 StudentProgramTranscriptResponse
    {
        public ResponseStatus responseStatus = 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 ResponseStatus getResponseStatus() { return responseStatus; }
        public StudentProgramTranscriptResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getProgramCode() { return program_code; }
        public StudentProgramTranscriptResponse setProgramCode(String value) { this.program_code = value; return this; }
        public String getProgramName() { return program_name; }
        public StudentProgramTranscriptResponse setProgramName(String value) { this.program_name = value; return this; }
        public String getConcentrationCode() { return concentration_code; }
        public StudentProgramTranscriptResponse setConcentrationCode(String value) { this.concentration_code = value; return this; }
        public String getConcentrationName() { return concentration_name; }
        public StudentProgramTranscriptResponse setConcentrationName(String value) { this.concentration_name = value; return this; }
        public Date getStartDate() { return start_date; }
        public StudentProgramTranscriptResponse setStartDate(Date value) { this.start_date = value; return this; }
    }

    public static class RegentDegreeResponse
    {
        public Integer id = null;
        public String program_code = null;
        public String program_name = null;
        public String concentration_code = null;
        public String concentration_name = null;
        public Date graduation_month = null;
        public Date start_date = null;
        public Date end_date = null;
        public BigDecimal gpa = null;
        public String academic_level = null;
        public Date commencement_date = null;
        public Date added_date = null;
        public String added_by = null;
        public Date changed_date = null;
        public String changed_by = null;
        public Date timestamp = null;
        
        public Integer getId() { return id; }
        public RegentDegreeResponse setId(Integer value) { this.id = value; return this; }
        public String getProgramCode() { return program_code; }
        public RegentDegreeResponse setProgramCode(String value) { this.program_code = value; return this; }
        public String getProgramName() { return program_name; }
        public RegentDegreeResponse setProgramName(String value) { this.program_name = value; return this; }
        public String getConcentrationCode() { return concentration_code; }
        public RegentDegreeResponse setConcentrationCode(String value) { this.concentration_code = value; return this; }
        public String getConcentrationName() { return concentration_name; }
        public RegentDegreeResponse setConcentrationName(String value) { this.concentration_name = value; return this; }
        public Date getGraduationMonth() { return graduation_month; }
        public RegentDegreeResponse setGraduationMonth(Date value) { this.graduation_month = value; return this; }
        public Date getStartDate() { return start_date; }
        public RegentDegreeResponse setStartDate(Date value) { this.start_date = value; return this; }
        public Date getEndDate() { return end_date; }
        public RegentDegreeResponse setEndDate(Date value) { this.end_date = value; return this; }
        public BigDecimal getGpa() { return gpa; }
        public RegentDegreeResponse setGpa(BigDecimal value) { this.gpa = value; return this; }
        public String getAcademicLevel() { return academic_level; }
        public RegentDegreeResponse setAcademicLevel(String value) { this.academic_level = value; return this; }
        public Date getCommencementDate() { return commencement_date; }
        public RegentDegreeResponse setCommencementDate(Date value) { this.commencement_date = value; return this; }
        public Date getAddedDate() { return added_date; }
        public RegentDegreeResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getAddedBy() { return added_by; }
        public RegentDegreeResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public RegentDegreeResponse setChangedDate(Date value) { this.changed_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public RegentDegreeResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getTimestamp() { return timestamp; }
        public RegentDegreeResponse setTimestamp(Date value) { this.timestamp = value; return this; }
    }

    public static class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse
    {
        public BigDecimal registered_credits = null;
        
        public BigDecimal getRegisteredCredits() { return registered_credits; }
        public StudentAcademicCredentialTranscriptResponse setRegisteredCredits(BigDecimal value) { this.registered_credits = value; return this; }
    }

    public static class StudentAcademicCredentialResponse
    {
        public ResponseStatus responseStatus = null;
        public String uuid = null;
        public String stac_uuid = null;
        public Integer section_id = null;
        public String course_name = null;
        public String section_code = null;
        public String subject = null;
        public Integer course_level = null;
        public String title = null;
        public String pretty_title = null;
        public String location = null;
        public Boolean is_audio = null;
        public Boolean is_oncampus = null;
        public BigDecimal credit_value = null;
        public BigDecimal audit_value = null;
        public Boolean is_audit = null;
        public Boolean is_pass_fail = null;
        public String grade = null;
        public Boolean is_grade_final = null;
        public BigDecimal gpa_credits = null;
        public BigDecimal grade_points = null;
        public String academic_level = null;
        public String printed_comments = null;
        public String term = null;
        public String reporting_term = null;
        public Integer reporting_year = null;
        public String current_status = 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 StudentAcademicCredentialResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getUuid() { return uuid; }
        public StudentAcademicCredentialResponse setUuid(String value) { this.uuid = value; return this; }
        public String getStacUuid() { return stac_uuid; }
        public StudentAcademicCredentialResponse setStacUuid(String value) { this.stac_uuid = value; return this; }
        public Integer getSectionId() { return section_id; }
        public StudentAcademicCredentialResponse setSectionId(Integer value) { this.section_id = value; return this; }
        public String getCourseName() { return course_name; }
        public StudentAcademicCredentialResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getSectionCode() { return section_code; }
        public StudentAcademicCredentialResponse setSectionCode(String value) { this.section_code = value; return this; }
        public String getSubject() { return subject; }
        public StudentAcademicCredentialResponse setSubject(String value) { this.subject = value; return this; }
        public Integer getCourseLevel() { return course_level; }
        public StudentAcademicCredentialResponse setCourseLevel(Integer value) { this.course_level = value; return this; }
        public String getTitle() { return title; }
        public StudentAcademicCredentialResponse setTitle(String value) { this.title = value; return this; }
        public String getPrettyTitle() { return pretty_title; }
        public StudentAcademicCredentialResponse setPrettyTitle(String value) { this.pretty_title = value; return this; }
        public String getLocation() { return location; }
        public StudentAcademicCredentialResponse setLocation(String value) { this.location = value; return this; }
        public Boolean getIsAudio() { return is_audio; }
        public StudentAcademicCredentialResponse setIsAudio(Boolean value) { this.is_audio = value; return this; }
        public Boolean getIsOncampus() { return is_oncampus; }
        public StudentAcademicCredentialResponse setIsOncampus(Boolean value) { this.is_oncampus = value; return this; }
        public BigDecimal getCreditValue() { return credit_value; }
        public StudentAcademicCredentialResponse setCreditValue(BigDecimal value) { this.credit_value = value; return this; }
        public BigDecimal getAuditValue() { return audit_value; }
        public StudentAcademicCredentialResponse setAuditValue(BigDecimal value) { this.audit_value = value; return this; }
        public Boolean getIsAudit() { return is_audit; }
        public StudentAcademicCredentialResponse setIsAudit(Boolean value) { this.is_audit = value; return this; }
        public Boolean getIsPassFail() { return is_pass_fail; }
        public StudentAcademicCredentialResponse setIsPassFail(Boolean value) { this.is_pass_fail = value; return this; }
        public String getGrade() { return grade; }
        public StudentAcademicCredentialResponse setGrade(String value) { this.grade = value; return this; }
        public Boolean getIsGradeFinal() { return is_grade_final; }
        public StudentAcademicCredentialResponse setIsGradeFinal(Boolean value) { this.is_grade_final = value; return this; }
        public BigDecimal getGpaCredits() { return gpa_credits; }
        public StudentAcademicCredentialResponse setGpaCredits(BigDecimal value) { this.gpa_credits = value; return this; }
        public BigDecimal getGradePoints() { return grade_points; }
        public StudentAcademicCredentialResponse setGradePoints(BigDecimal value) { this.grade_points = value; return this; }
        public String getAcademicLevel() { return academic_level; }
        public StudentAcademicCredentialResponse setAcademicLevel(String value) { this.academic_level = value; return this; }
        public String getPrintedComments() { return printed_comments; }
        public StudentAcademicCredentialResponse setPrintedComments(String value) { this.printed_comments = value; return this; }
        public String getTerm() { return term; }
        public StudentAcademicCredentialResponse setTerm(String value) { this.term = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public StudentAcademicCredentialResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Integer getReportingYear() { return reporting_year; }
        public StudentAcademicCredentialResponse setReportingYear(Integer value) { this.reporting_year = value; return this; }
        public String getCurrentStatus() { return current_status; }
        public StudentAcademicCredentialResponse setCurrentStatus(String value) { this.current_status = value; return this; }
        public String getAddedBy() { return added_by; }
        public StudentAcademicCredentialResponse setAddedBy(String value) { this.added_by = value; return this; }
        public Date getAddedDate() { return added_date; }
        public StudentAcademicCredentialResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public String getChangedBy() { return changed_by; }
        public StudentAcademicCredentialResponse setChangedBy(String value) { this.changed_by = value; return this; }
        public Date getChangedDate() { return changed_date; }
        public StudentAcademicCredentialResponse setChangedDate(Date value) { this.changed_date = value; return this; }
    }

    public static class StudentTransferCredentialsTranscriptResponse
    {
        public String institution_name = null;
        public ArrayList<StudentTransferCredentialTranscriptResponse> transferCredits = null;
        
        public String getInstitutionName() { return institution_name; }
        public StudentTransferCredentialsTranscriptResponse setInstitutionName(String value) { this.institution_name = value; return this; }
        public ArrayList<StudentTransferCredentialTranscriptResponse> getTransferCredits() { return transferCredits; }
        public StudentTransferCredentialsTranscriptResponse setTransferCredits(ArrayList<StudentTransferCredentialTranscriptResponse> value) { this.transferCredits = value; return this; }
    }

    public static class StudentTransferCredentialTranscriptResponse
    {
        public String course_name = null;
        public String title = null;
        public Boolean is_advanced_standing = null;
        public BigDecimal credit_value = null;
        
        public String getCourseName() { return course_name; }
        public StudentTransferCredentialTranscriptResponse setCourseName(String value) { this.course_name = value; return this; }
        public String getTitle() { return title; }
        public StudentTransferCredentialTranscriptResponse setTitle(String value) { this.title = value; return this; }
        public Boolean getIsAdvancedStanding() { return is_advanced_standing; }
        public StudentTransferCredentialTranscriptResponse setIsAdvancedStanding(Boolean value) { this.is_advanced_standing = value; return this; }
        public BigDecimal getCreditValue() { return credit_value; }
        public StudentTransferCredentialTranscriptResponse setCreditValue(BigDecimal value) { this.credit_value = value; return this; }
    }

}

Java TranscriptRequest 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 /Transcript/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","academic_level":"String","override_all_restrictions":false,"override_nonfinancial_restrictions":false,"authorizing_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"}},"first_name":"String","last_name":"String","middle_name":"String","override_name":"String","regent_id":0,"academic_level":"String","dob":"0001-01-01T00:00:00.0000000","previous_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}],"student_programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000"}],"regent_degrees":[{"id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","graduation_month":"0001-01-01T00:00:00.0000000","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","gpa":0,"academic_level":"String","commencement_date":"0001-01-01T00:00:00.0000000","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String","timestamp":"0001-01-01T00:00:00.0000000"}],"student_academic_credentials":[{"registered_credits":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","pretty_title":"String","location":"String","is_audio":false,"is_oncampus":false,"credit_value":0,"audit_value":0,"is_audit":false,"is_pass_fail":false,"grade":"String","is_grade_final":false,"gpa_credits":0,"grade_points":0,"academic_level":"String","printed_comments":"String","term":"String","reporting_term":"String","reporting_year":0,"current_status":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000"}],"transfer_credentials":[{"institution_name":"String","transferCredits":[{"course_name":"String","title":"String","is_advanced_standing":false,"credit_value":0}]}],"transcript_notes":["String"]}