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 Foundation
import ServiceStack

public class GradeByCourseRequest : Codable
{
    public var secUUID:String
    public var include_crosslist:Bool

    required public init(){}
}

public class GradeByCourseResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var secUUID:String
    public var gradingEndDate:Date?
    public var overrideGradingEndDate:Date?
    public var course_name:String
    public var title:String
    public var term:String
    public var crosslists_included:Bool
    public var has_crosslists:Bool
    public var studentAcademicCredentials:[StudentAcademicCredentialAndStudentResponse] = []
    public var studentAcademicCredentialRetakes:[StudentAcademicCredentialAndStudentResponse] = []
    public var studentAcademicCredentialExtensions:[StudentAcademicCredentialExtensionResponse] = []
    public var validGrades:[GradeResponse] = []

    required public init(){}
}

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

    required public init(){}
}

public class StudentAcademicCredentialExtensionResponse : Codable
{
    public var uuid:String
    public var stac_uuid:String
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var course_name:String
    public var section_code:String
    public var location_code:String
    public var title:String
    public var term:String
    public var reporting_term:String
    public var is_audit:Bool
    public var is_active:Bool
    public var amount:Double
    public var instructors:[InstructorResponse] = []
    public var due_date:Date?
    public var received_date:Date?
    public var grade_penalty:String
    public var assignments:String
    public var comments:String
    public var added_date:Date?
    public var added_by:String
    public var changed_date:Date?
    public var changed_by:String

    required public init(){}
}

public class InstructorResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var regent_login:String
    public var preferred_name:String
    public var first_name:String
    public var last_name:String
    public var full_name:String
    public var email:String
    public var image_base64:String

    required public init(){}
}

public class GradeResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var id:Int
    public var grade_code:String
    public var grade_name:String
    public var grade_points:Double
    public var gpa_credit:Bool
    public var completed_credit:Bool

    required public init(){}
}


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