regis

<back to all web services

GradeByCourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{secUUID}/Grade
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GradeByCourseRequest
{
    var secUUID:String? = null
    var include_crosslist:Boolean? = null
}

open class GradeByCourseResponse
{
    var responseStatus:ResponseStatus? = null
    var secUUID:String? = null
    var gradingEndDate:Date? = null
    var overrideGradingEndDate:Date? = null
    var course_name:String? = null
    var title:String? = null
    var term:String? = null
    var crosslists_included:Boolean? = null
    var has_crosslists:Boolean? = null
    var studentAcademicCredentials:ArrayList<StudentAcademicCredentialAndStudentResponse> = ArrayList<StudentAcademicCredentialAndStudentResponse>()
    var studentAcademicCredentialRetakes:ArrayList<StudentAcademicCredentialAndStudentResponse> = ArrayList<StudentAcademicCredentialAndStudentResponse>()
    var studentAcademicCredentialExtensions:ArrayList<StudentAcademicCredentialExtensionResponse> = ArrayList<StudentAcademicCredentialExtensionResponse>()
    var validGrades:ArrayList<GradeResponse> = ArrayList<GradeResponse>()
}

open class StudentAcademicCredentialAndStudentResponse
{
    var responseStatus:ResponseStatus? = null
    var uuid:String? = null
    var regent_id:Int? = null
    var student_name:String? = null
    var last_name:String? = null
    var first_name:String? = null
    var current_program:String? = null
    var applied_to_graduate_from_programs:String? = null
    var additional_instructors:String? = null
    var stac_uuid:String? = null
    var section_id:Int? = null
    var course_name:String? = null
    var section_code:String? = null
    var subject:String? = null
    var course_level:Int? = null
    var title:String? = null
    var location:String? = null
    var is_audio:Boolean? = null
    var credit_value:BigDecimal? = null
    var audit_value:BigDecimal? = null
    var is_audit:Boolean? = null
    var is_pass_fail:Boolean? = null
    var grade:String? = null
    var is_grade_final:Boolean? = null
    var gpa_credits:BigDecimal? = null
    var grade_points:BigDecimal? = null
    var academic_level:String? = null
    var printed_comments:String? = null
    var term:String? = null
    var reporting_term:String? = null
    var reporting_year:Int? = null
    var current_status:String? = null
    var added_by:String? = null
    var added_date:Date? = null
    var changed_by:String? = null
    var changed_date:Date? = null
}

open class StudentAcademicCredentialExtensionResponse
{
    var uuid:String? = null
    var stac_uuid:String? = null
    var regent_id:Int? = null
    var first_name:String? = null
    var last_name:String? = null
    var course_name:String? = null
    var section_code:String? = null
    var location_code:String? = null
    var title:String? = null
    var term:String? = null
    var reporting_term:String? = null
    var is_audit:Boolean? = null
    var is_active:Boolean? = null
    var amount:BigDecimal? = null
    var instructors:ArrayList<InstructorResponse> = ArrayList<InstructorResponse>()
    var due_date:Date? = null
    var received_date:Date? = null
    var grade_penalty:String? = null
    var assignments:String? = null
    var comments:String? = null
    var added_date:Date? = null
    var added_by:String? = null
    var changed_date:Date? = null
    var changed_by:String? = null
}

open class InstructorResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var regent_login:String? = null
    var preferred_name:String? = null
    var first_name:String? = null
    var last_name:String? = null
    var full_name:String? = null
    var email:String? = null
    var image_base64:String? = null
}

open class GradeResponse
{
    var responseStatus:ResponseStatus? = null
    var id:Int? = null
    var grade_code:String? = null
    var grade_name:String? = null
    var grade_points:BigDecimal? = null
    var gpa_credit:Boolean? = null
    var completed_credit:Boolean? = null
}

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