regis

TranscriptRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Transcript/{uuid}


export class ExternalDegreeResponse
{
    public id?: number;
    public institution_id?: number;
    public degree_name: string;
    public degree_override_name: string;
    public institution_name: string;
    public graduation_month: string;
    public start_year?: number;
    public end_year?: number;
    public is_only_in_d365: boolean;

    public constructor(init?: Partial<ExternalDegreeResponse>) { (Object as any).assign(this, init); }
}

export class StudentProgramTranscriptResponse
{
    public responseStatus: ResponseStatus;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public start_date?: string;

    public constructor(init?: Partial<StudentProgramTranscriptResponse>) { (Object as any).assign(this, init); }
}

export class RegentDegreeResponse
{
    public id: number;
    public program_code: string;
    public program_name: string;
    public concentration_code: string;
    public concentration_name: string;
    public graduation_month?: string;
    public start_date?: string;
    public end_date?: string;
    public gpa?: number;
    public academic_level: string;
    public commencement_date?: string;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;
    public timestamp: string;

    public constructor(init?: Partial<RegentDegreeResponse>) { (Object as any).assign(this, init); }
}

export class StudentAcademicCredentialResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public stac_uuid: string;
    public section_id?: number;
    public course_name: string;
    public section_code: string;
    public subject: string;
    public course_level?: number;
    public title: string;
    public pretty_title: string;
    public location: string;
    public is_audio: boolean;
    public is_oncampus: boolean;
    public credit_value?: number;
    public audit_value?: number;
    public is_audit: boolean;
    public is_pass_fail: boolean;
    public grade: string;
    public is_grade_final: boolean;
    public gpa_credits?: number;
    public grade_points?: number;
    public academic_level: string;
    public printed_comments: string;
    public term: string;
    public reporting_term: string;
    public reporting_year?: number;
    public current_status: string;
    public added_by: string;
    public added_date?: string;
    public changed_by: string;
    public changed_date?: string;

    public constructor(init?: Partial<StudentAcademicCredentialResponse>) { (Object as any).assign(this, init); }
}

export class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse
{
    public registered_credits?: number;

    public constructor(init?: Partial<StudentAcademicCredentialTranscriptResponse>) { super(init); (Object as any).assign(this, init); }
}

export class StudentTransferCredentialTranscriptResponse
{
    public course_name: string;
    public title: string;
    public is_advanced_standing: boolean;
    public credit_value?: number;

    public constructor(init?: Partial<StudentTransferCredentialTranscriptResponse>) { (Object as any).assign(this, init); }
}

export class StudentTransferCredentialsTranscriptResponse
{
    public institution_name: string;
    public transferCredits: StudentTransferCredentialTranscriptResponse[];

    public constructor(init?: Partial<StudentTransferCredentialsTranscriptResponse>) { (Object as any).assign(this, init); }
}

export class TranscriptResponse
{
    public responseStatus: ResponseStatus;
    public first_name: string;
    public last_name: string;
    public middle_name: string;
    public override_name: string;
    public regent_id: number;
    public academic_level: string;
    public dob: string;
    public previous_degrees: ExternalDegreeResponse[];
    public student_programs: StudentProgramTranscriptResponse[];
    public regent_degrees: RegentDegreeResponse[];
    public student_academic_credentials: StudentAcademicCredentialTranscriptResponse[];
    public transfer_credentials: StudentTransferCredentialsTranscriptResponse[];
    public transcript_notes: string[];

    public constructor(init?: Partial<TranscriptResponse>) { (Object as any).assign(this, init); }
}

export class TranscriptRequest
{
    public uuid: string;
    public academic_level: string;
    public override_all_restrictions: boolean;
    public override_nonfinancial_restrictions: boolean;
    public authorizing_uuid: string;

    public constructor(init?: Partial<TranscriptRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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"]}