regis

<back to all web services

TranscriptRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Transcript/{uuid}
"use strict";
export class ExternalDegreeResponse {
    /** @param {{id?:number,institution_id?:number,degree_name?:string,degree_override_name?:string,institution_name?:string,graduation_month?:string,start_year?:number,end_year?:number,is_only_in_d365?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    id;
    /** @type {?number} */
    institution_id;
    /** @type {string} */
    degree_name;
    /** @type {string} */
    degree_override_name;
    /** @type {string} */
    institution_name;
    /** @type {string} */
    graduation_month;
    /** @type {?number} */
    start_year;
    /** @type {?number} */
    end_year;
    /** @type {boolean} */
    is_only_in_d365;
}
export class StudentProgramTranscriptResponse {
    /** @param {{responseStatus?:ResponseStatus,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,start_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_name;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {?string} */
    start_date;
}
export class RegentDegreeResponse {
    /** @param {{id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,graduation_month?:string,start_date?:string,end_date?:string,gpa?:number,academic_level?:string,commencement_date?:string,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string,timestamp?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    id;
    /** @type {string} */
    program_code;
    /** @type {string} */
    program_name;
    /** @type {string} */
    concentration_code;
    /** @type {string} */
    concentration_name;
    /** @type {?string} */
    graduation_month;
    /** @type {?string} */
    start_date;
    /** @type {?string} */
    end_date;
    /** @type {?number} */
    gpa;
    /** @type {string} */
    academic_level;
    /** @type {?string} */
    commencement_date;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    changed_by;
    /** @type {string} */
    timestamp;
}
export class StudentAcademicCredentialResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,stac_uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,pretty_title?:string,location?:string,is_audio?:boolean,is_oncampus?:boolean,credit_value?:number,audit_value?:number,is_audit?:boolean,is_pass_fail?:boolean,grade?:string,is_grade_final?:boolean,gpa_credits?:number,grade_points?:number,academic_level?:string,printed_comments?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {string} */
    stac_uuid;
    /** @type {?number} */
    section_id;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    subject;
    /** @type {?number} */
    course_level;
    /** @type {string} */
    title;
    /** @type {string} */
    pretty_title;
    /** @type {string} */
    location;
    /** @type {boolean} */
    is_audio;
    /** @type {boolean} */
    is_oncampus;
    /** @type {?number} */
    credit_value;
    /** @type {?number} */
    audit_value;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_pass_fail;
    /** @type {string} */
    grade;
    /** @type {boolean} */
    is_grade_final;
    /** @type {?number} */
    gpa_credits;
    /** @type {?number} */
    grade_points;
    /** @type {string} */
    academic_level;
    /** @type {string} */
    printed_comments;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {?number} */
    reporting_year;
    /** @type {string} */
    current_status;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse {
    /** @param {{registered_credits?:number,responseStatus?:ResponseStatus,uuid?:string,stac_uuid?:string,section_id?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,pretty_title?:string,location?:string,is_audio?:boolean,is_oncampus?:boolean,credit_value?:number,audit_value?:number,is_audit?:boolean,is_pass_fail?:boolean,grade?:string,is_grade_final?:boolean,gpa_credits?:number,grade_points?:number,academic_level?:string,printed_comments?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    registered_credits;
}
export class StudentTransferCredentialTranscriptResponse {
    /** @param {{course_name?:string,title?:string,is_advanced_standing?:boolean,credit_value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {boolean} */
    is_advanced_standing;
    /** @type {?number} */
    credit_value;
}
export class StudentTransferCredentialsTranscriptResponse {
    /** @param {{institution_name?:string,transferCredits?:StudentTransferCredentialTranscriptResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    institution_name;
    /** @type {StudentTransferCredentialTranscriptResponse[]} */
    transferCredits;
}
export class TranscriptResponse {
    /** @param {{responseStatus?:ResponseStatus,first_name?:string,last_name?:string,middle_name?:string,override_name?:string,regent_id?:number,academic_level?:string,dob?:string,previous_degrees?:ExternalDegreeResponse[],student_programs?:StudentProgramTranscriptResponse[],regent_degrees?:RegentDegreeResponse[],student_academic_credentials?:StudentAcademicCredentialTranscriptResponse[],transfer_credentials?:StudentTransferCredentialsTranscriptResponse[],transcript_notes?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    override_name;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    academic_level;
    /** @type {string} */
    dob;
    /** @type {ExternalDegreeResponse[]} */
    previous_degrees;
    /** @type {StudentProgramTranscriptResponse[]} */
    student_programs;
    /** @type {RegentDegreeResponse[]} */
    regent_degrees;
    /** @type {StudentAcademicCredentialTranscriptResponse[]} */
    student_academic_credentials;
    /** @type {StudentTransferCredentialsTranscriptResponse[]} */
    transfer_credentials;
    /** @type {string[]} */
    transcript_notes;
}
export class TranscriptRequest {
    /** @param {{uuid?:string,academic_level?:string,override_all_restrictions?:boolean,override_nonfinancial_restrictions?:boolean,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    academic_level;
    /** @type {boolean} */
    override_all_restrictions;
    /** @type {boolean} */
    override_nonfinancial_restrictions;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript TranscriptRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
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"]}