| Required role: | REGISUserRole |
| POST | /Academic/Student/{uuid}/Grade |
|---|
"use strict";
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 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 GradeByStudentResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,studentAcademicCredentials?:StudentAcademicCredentialResponse[],studentAcademicCredentialRetakes?:StudentAcademicCredentialResponse[],studentAcademicCredentialExtensions?:StudentAcademicCredentialExtensionResponse[],validGrades?:GradeResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {StudentAcademicCredentialResponse[]} */
studentAcademicCredentials;
/** @type {StudentAcademicCredentialResponse[]} */
studentAcademicCredentialRetakes;
/** @type {StudentAcademicCredentialExtensionResponse[]} */
studentAcademicCredentialExtensions;
/** @type {GradeResponse[]} */
validGrades;
}
export class GradeByStudentRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript GradeByStudentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/Student/{uuid}/Grade HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GradeByStudentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</GradeByStudentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GradeByStudentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<regent_id>0</regent_id>
<studentAcademicCredentialExtensions>
<StudentAcademicCredentialExtensionResponse>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<amount>0</amount>
<assignments>String</assignments>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<comments>String</comments>
<course_name>String</course_name>
<due_date>0001-01-01T00:00:00</due_date>
<first_name>String</first_name>
<grade_penalty>String</grade_penalty>
<instructors>
<InstructorResponse>
<ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types">
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:Message>String</d6p1:Message>
<d6p1:StackTrace>String</d6p1:StackTrace>
<d6p1:Errors>
<d6p1:ResponseError>
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:FieldName>String</d6p1:FieldName>
<d6p1:Message>String</d6p1:Message>
<d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:KeyValueOfstringstring>
<d9p1:Key>String</d9p1:Key>
<d9p1:Value>String</d9p1:Value>
</d9p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<email>String</email>
<first_name>String</first_name>
<full_name>String</full_name>
<image_base64>String</image_base64>
<last_name>String</last_name>
<preferred_name>String</preferred_name>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
</InstructorResponse>
</instructors>
<is_active>false</is_active>
<is_audit>false</is_audit>
<last_name>String</last_name>
<location_code>String</location_code>
<received_date>0001-01-01T00:00:00</received_date>
<regent_id>0</regent_id>
<reporting_term>String</reporting_term>
<section_code>String</section_code>
<stac_uuid>String</stac_uuid>
<term>String</term>
<title>String</title>
<uuid>String</uuid>
</StudentAcademicCredentialExtensionResponse>
</studentAcademicCredentialExtensions>
<studentAcademicCredentialRetakes>
<StudentAcademicCredentialResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Meta>
</ResponseStatus>
<academic_level>String</academic_level>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<audit_value>0</audit_value>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<course_level>0</course_level>
<course_name>String</course_name>
<credit_value>0</credit_value>
<current_status>String</current_status>
<gpa_credits>0</gpa_credits>
<grade>String</grade>
<grade_points>0</grade_points>
<is_audio>false</is_audio>
<is_audit>false</is_audit>
<is_grade_final>false</is_grade_final>
<is_oncampus>false</is_oncampus>
<is_pass_fail>false</is_pass_fail>
<location>String</location>
<pretty_title>String</pretty_title>
<printed_comments>String</printed_comments>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<section_code>String</section_code>
<section_id>0</section_id>
<stac_uuid>String</stac_uuid>
<subject>String</subject>
<term>String</term>
<title>String</title>
<uuid>String</uuid>
</StudentAcademicCredentialResponse>
</studentAcademicCredentialRetakes>
<studentAcademicCredentials>
<StudentAcademicCredentialResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Meta>
</ResponseStatus>
<academic_level>String</academic_level>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<audit_value>0</audit_value>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<course_level>0</course_level>
<course_name>String</course_name>
<credit_value>0</credit_value>
<current_status>String</current_status>
<gpa_credits>0</gpa_credits>
<grade>String</grade>
<grade_points>0</grade_points>
<is_audio>false</is_audio>
<is_audit>false</is_audit>
<is_grade_final>false</is_grade_final>
<is_oncampus>false</is_oncampus>
<is_pass_fail>false</is_pass_fail>
<location>String</location>
<pretty_title>String</pretty_title>
<printed_comments>String</printed_comments>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<section_code>String</section_code>
<section_id>0</section_id>
<stac_uuid>String</stac_uuid>
<subject>String</subject>
<term>String</term>
<title>String</title>
<uuid>String</uuid>
</StudentAcademicCredentialResponse>
</studentAcademicCredentials>
<uuid>String</uuid>
<validGrades>
<GradeResponse>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d4p1:Meta>
</ResponseStatus>
<completed_credit>false</completed_credit>
<gpa_credit>false</gpa_credit>
<grade_code>String</grade_code>
<grade_name>String</grade_name>
<grade_points>0</grade_points>
<id>0</id>
</GradeResponse>
</validGrades>
</GradeByStudentResponse>