regis

<back to all web services

GradeByCourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{secUUID}/Grade
"use strict";
export class StudentAcademicCredentialAndStudentResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,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?:number,course_name?:string,section_code?:string,subject?:string,course_level?:number,title?:string,location?:string,is_audio?: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 {number} */
    regent_id;
    /** @type {string} */
    student_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    first_name;
    /** @type {string} */
    current_program;
    /** @type {string} */
    applied_to_graduate_from_programs;
    /** @type {string} */
    additional_instructors;
    /** @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} */
    location;
    /** @type {boolean} */
    is_audio;
    /** @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 InstructorResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,regent_login?:string,preferred_name?:string,first_name?:string,last_name?:string,full_name?:string,email?:string,image_base64?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    regent_login;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    full_name;
    /** @type {string} */
    email;
    /** @type {string} */
    image_base64;
}
export class StudentAcademicCredentialExtensionResponse {
    /** @param {{uuid?:string,stac_uuid?:string,regent_id?:number,first_name?:string,last_name?:string,course_name?:string,section_code?:string,location_code?:string,title?:string,term?:string,reporting_term?:string,is_audit?:boolean,is_active?:boolean,amount?:number,instructors?:InstructorResponse[],due_date?:string,received_date?:string,grade_penalty?:string,assignments?:string,comments?:string,added_date?:string,added_by?:string,changed_date?:string,changed_by?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    stac_uuid;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    course_name;
    /** @type {string} */
    section_code;
    /** @type {string} */
    location_code;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {string} */
    reporting_term;
    /** @type {boolean} */
    is_audit;
    /** @type {boolean} */
    is_active;
    /** @type {number} */
    amount;
    /** @type {InstructorResponse[]} */
    instructors;
    /** @type {?string} */
    due_date;
    /** @type {?string} */
    received_date;
    /** @type {string} */
    grade_penalty;
    /** @type {string} */
    assignments;
    /** @type {string} */
    comments;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    changed_date;
    /** @type {string} */
    changed_by;
}
export class GradeResponse {
    /** @param {{responseStatus?:ResponseStatus,id?:number,grade_code?:string,grade_name?:string,grade_points?:number,gpa_credit?:boolean,completed_credit?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    id;
    /** @type {string} */
    grade_code;
    /** @type {string} */
    grade_name;
    /** @type {number} */
    grade_points;
    /** @type {boolean} */
    gpa_credit;
    /** @type {boolean} */
    completed_credit;
}
export class GradeByCourseResponse {
    /** @param {{responseStatus?:ResponseStatus,secUUID?:string,gradingEndDate?:string,overrideGradingEndDate?:string,course_name?:string,title?:string,term?:string,crosslists_included?:boolean,has_crosslists?:boolean,studentAcademicCredentials?:StudentAcademicCredentialAndStudentResponse[],studentAcademicCredentialRetakes?:StudentAcademicCredentialAndStudentResponse[],studentAcademicCredentialExtensions?:StudentAcademicCredentialExtensionResponse[],validGrades?:GradeResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    secUUID;
    /** @type {?string} */
    gradingEndDate;
    /** @type {?string} */
    overrideGradingEndDate;
    /** @type {string} */
    course_name;
    /** @type {string} */
    title;
    /** @type {string} */
    term;
    /** @type {boolean} */
    crosslists_included;
    /** @type {boolean} */
    has_crosslists;
    /** @type {StudentAcademicCredentialAndStudentResponse[]} */
    studentAcademicCredentials;
    /** @type {StudentAcademicCredentialAndStudentResponse[]} */
    studentAcademicCredentialRetakes;
    /** @type {StudentAcademicCredentialExtensionResponse[]} */
    studentAcademicCredentialExtensions;
    /** @type {GradeResponse[]} */
    validGrades;
}
export class GradeByCourseRequest {
    /** @param {{secUUID?:string,include_crosslist?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    secUUID;
    /** @type {boolean} */
    include_crosslist;
}

JavaScript 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}]}