regis

<back to all web services

GradeByCourseRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Academic/{secUUID}/Grade
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class GradeByCourseRequest
            Public Overridable Property secUUID As String
            Public Overridable Property include_crosslist As Boolean
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class GradeByCourseResponse
            Public Sub New()
                studentAcademicCredentials = New List(Of StudentAcademicCredentialAndStudentResponse)
                studentAcademicCredentialRetakes = New List(Of StudentAcademicCredentialAndStudentResponse)
                studentAcademicCredentialExtensions = New List(Of StudentAcademicCredentialExtensionResponse)
                validGrades = New List(Of GradeResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property secUUID As String
            Public Overridable Property gradingEndDate As Nullable(Of Date)
            Public Overridable Property overrideGradingEndDate As Nullable(Of Date)
            Public Overridable Property course_name As String
            Public Overridable Property title As String
            Public Overridable Property term As String
            Public Overridable Property crosslists_included As Boolean
            Public Overridable Property has_crosslists As Boolean
            Public Overridable Property studentAcademicCredentials As List(Of StudentAcademicCredentialAndStudentResponse)
            Public Overridable Property studentAcademicCredentialRetakes As List(Of StudentAcademicCredentialAndStudentResponse)
            Public Overridable Property studentAcademicCredentialExtensions As List(Of StudentAcademicCredentialExtensionResponse)
            Public Overridable Property validGrades As List(Of GradeResponse)
        End Class

        Public Partial Class GradeResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property id As Integer
            Public Overridable Property grade_code As String
            Public Overridable Property grade_name As String
            Public Overridable Property grade_points As Decimal
            Public Overridable Property gpa_credit As Boolean
            Public Overridable Property completed_credit As Boolean
        End Class

        Public Partial Class InstructorResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property regent_id As Integer
            Public Overridable Property regent_login As String
            Public Overridable Property preferred_name As String
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property full_name As String
            Public Overridable Property email As String
            Public Overridable Property image_base64 As String
        End Class

        Public Partial Class StudentAcademicCredentialAndStudentResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property student_name As String
            Public Overridable Property last_name As String
            Public Overridable Property first_name As String
            Public Overridable Property current_program As String
            Public Overridable Property applied_to_graduate_from_programs As String
            Public Overridable Property additional_instructors As String
            Public Overridable Property stac_uuid As String
            Public Overridable Property section_id As Nullable(Of Integer)
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property subject As String
            Public Overridable Property course_level As Nullable(Of Integer)
            Public Overridable Property title As String
            Public Overridable Property location As String
            Public Overridable Property is_audio As Boolean
            Public Overridable Property credit_value As Nullable(Of Decimal)
            Public Overridable Property audit_value As Nullable(Of Decimal)
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_pass_fail As Boolean
            Public Overridable Property grade As String
            Public Overridable Property is_grade_final As Boolean
            Public Overridable Property gpa_credits As Nullable(Of Decimal)
            Public Overridable Property grade_points As Nullable(Of Decimal)
            Public Overridable Property academic_level As String
            Public Overridable Property printed_comments As String
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property reporting_year As Nullable(Of Integer)
            Public Overridable Property current_status As String
            Public Overridable Property added_by As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
        End Class

        Public Partial Class StudentAcademicCredentialExtensionResponse
            Public Sub New()
                instructors = New List(Of InstructorResponse)
            End Sub

            Public Overridable Property uuid As String
            Public Overridable Property stac_uuid As String
            Public Overridable Property regent_id As Integer
            Public Overridable Property first_name As String
            Public Overridable Property last_name As String
            Public Overridable Property course_name As String
            Public Overridable Property section_code As String
            Public Overridable Property location_code As String
            Public Overridable Property title As String
            Public Overridable Property term As String
            Public Overridable Property reporting_term As String
            Public Overridable Property is_audit As Boolean
            Public Overridable Property is_active As Boolean
            Public Overridable Property amount As Decimal
            Public Overridable Property instructors As List(Of InstructorResponse)
            Public Overridable Property due_date As Nullable(Of Date)
            Public Overridable Property received_date As Nullable(Of Date)
            Public Overridable Property grade_penalty As String
            Public Overridable Property assignments As String
            Public Overridable Property comments As String
            Public Overridable Property added_date As Nullable(Of Date)
            Public Overridable Property added_by As String
            Public Overridable Property changed_date As Nullable(Of Date)
            Public Overridable Property changed_by As String
        End Class
    End Namespace
End Namespace

VB.NET 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}]}