regis

GradeByStudentRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Academic/Student/{uuid}/Grade

import Foundation
import ServiceStack

public class GradeByStudentRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class GradeByStudentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var uuid:String
    public var studentAcademicCredentials:[StudentAcademicCredentialResponse] = []
    public var studentAcademicCredentialRetakes:[StudentAcademicCredentialResponse] = []
    public var studentAcademicCredentialExtensions:[StudentAcademicCredentialExtensionResponse] = []
    public var validGrades:[GradeResponse] = []

    required public init(){}
}

public class StudentAcademicCredentialResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var uuid: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 pretty_title:String
    public var location:String
    public var is_audio:Bool
    public var is_oncampus: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 GradeByStudentRequest 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/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>