regis

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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GradeByCourseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <include_crosslist>false</include_crosslist>
  <secUUID>String</secUUID>
</GradeByCourseRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GradeByCourseResponse 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>
  <course_name>String</course_name>
  <crosslists_included>false</crosslists_included>
  <gradingEndDate>0001-01-01T00:00:00</gradingEndDate>
  <has_crosslists>false</has_crosslists>
  <overrideGradingEndDate>0001-01-01T00:00:00</overrideGradingEndDate>
  <secUUID>String</secUUID>
  <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>
    <StudentAcademicCredentialAndStudentResponse>
      <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>
      <additional_instructors>String</additional_instructors>
      <applied_to_graduate_from_programs>String</applied_to_graduate_from_programs>
      <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_program>String</current_program>
      <current_status>String</current_status>
      <first_name>String</first_name>
      <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_pass_fail>false</is_pass_fail>
      <last_name>String</last_name>
      <location>String</location>
      <printed_comments>String</printed_comments>
      <regent_id>0</regent_id>
      <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>
      <student_name>String</student_name>
      <subject>String</subject>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </StudentAcademicCredentialAndStudentResponse>
  </studentAcademicCredentialRetakes>
  <studentAcademicCredentials>
    <StudentAcademicCredentialAndStudentResponse>
      <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>
      <additional_instructors>String</additional_instructors>
      <applied_to_graduate_from_programs>String</applied_to_graduate_from_programs>
      <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_program>String</current_program>
      <current_status>String</current_status>
      <first_name>String</first_name>
      <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_pass_fail>false</is_pass_fail>
      <last_name>String</last_name>
      <location>String</location>
      <printed_comments>String</printed_comments>
      <regent_id>0</regent_id>
      <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>
      <student_name>String</student_name>
      <subject>String</subject>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </StudentAcademicCredentialAndStudentResponse>
  </studentAcademicCredentials>
  <term>String</term>
  <title>String</title>
  <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>
</GradeByCourseResponse>