regis

<back to all web services

GradeByCourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{secUUID}/Grade

export class StudentAcademicCredentialAndStudentResponse
{
    public responseStatus: ResponseStatus;
    public uuid: string;
    public regent_id: number;
    public student_name: string;
    public last_name: string;
    public first_name: string;
    public current_program: string;
    public applied_to_graduate_from_programs: string;
    public additional_instructors: 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 location: string;
    public is_audio: 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<StudentAcademicCredentialAndStudentResponse>) { (Object as any).assign(this, init); }
}

export class InstructorResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public regent_login: string;
    public preferred_name: string;
    public first_name: string;
    public last_name: string;
    public full_name: string;
    public email: string;
    public image_base64: string;

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

export class StudentAcademicCredentialExtensionResponse
{
    public uuid: string;
    public stac_uuid: string;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public course_name: string;
    public section_code: string;
    public location_code: string;
    public title: string;
    public term: string;
    public reporting_term: string;
    public is_audit: boolean;
    public is_active: boolean;
    public amount: number;
    public instructors: InstructorResponse[];
    public due_date?: string;
    public received_date?: string;
    public grade_penalty: string;
    public assignments: string;
    public comments: string;
    public added_date?: string;
    public added_by: string;
    public changed_date?: string;
    public changed_by: string;

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

export class GradeResponse
{
    public responseStatus: ResponseStatus;
    public id: number;
    public grade_code: string;
    public grade_name: string;
    public grade_points: number;
    public gpa_credit: boolean;
    public completed_credit: boolean;

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

export class GradeByCourseResponse
{
    public responseStatus: ResponseStatus;
    public secUUID: string;
    public gradingEndDate?: string;
    public overrideGradingEndDate?: string;
    public course_name: string;
    public title: string;
    public term: string;
    public crosslists_included: boolean;
    public has_crosslists: boolean;
    public studentAcademicCredentials: StudentAcademicCredentialAndStudentResponse[];
    public studentAcademicCredentialRetakes: StudentAcademicCredentialAndStudentResponse[];
    public studentAcademicCredentialExtensions: StudentAcademicCredentialExtensionResponse[];
    public validGrades: GradeResponse[];

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

export class GradeByCourseRequest
{
    public secUUID: string;
    public include_crosslist: boolean;

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

TypeScript GradeByCourseRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Academic/{secUUID}/Grade HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"secUUID":"String","include_crosslist":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"secUUID":"String","gradingEndDate":"0001-01-01T00:00:00.0000000","overrideGradingEndDate":"0001-01-01T00:00:00.0000000","course_name":"String","title":"String","term":"String","crosslists_included":false,"has_crosslists":false,"studentAcademicCredentials":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"student_name":"String","last_name":"String","first_name":"String","current_program":"String","applied_to_graduate_from_programs":"String","additional_instructors":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","location":"String","is_audio":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"}],"studentAcademicCredentialRetakes":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"uuid":"String","regent_id":0,"student_name":"String","last_name":"String","first_name":"String","current_program":"String","applied_to_graduate_from_programs":"String","additional_instructors":"String","stac_uuid":"String","section_id":0,"course_name":"String","section_code":"String","subject":"String","course_level":0,"title":"String","location":"String","is_audio":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"}],"studentAcademicCredentialExtensions":[{"uuid":"String","stac_uuid":"String","regent_id":0,"first_name":"String","last_name":"String","course_name":"String","section_code":"String","location_code":"String","title":"String","term":"String","reporting_term":"String","is_audit":false,"is_active":false,"amount":0,"instructors":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"regent_login":"String","preferred_name":"String","first_name":"String","last_name":"String","full_name":"String","email":"String","image_base64":"String"}],"due_date":"0001-01-01T00:00:00.0000000","received_date":"0001-01-01T00:00:00.0000000","grade_penalty":"String","assignments":"String","comments":"String","added_date":"0001-01-01T00:00:00.0000000","added_by":"String","changed_date":"0001-01-01T00:00:00.0000000","changed_by":"String"}],"validGrades":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"grade_code":"String","grade_name":"String","grade_points":0,"gpa_credit":false,"completed_credit":false}]}