regis

<back to all web services

GradeByCourseRequest

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

namespace regis.ClassLibrary.Requests
{
    public partial class GradeByCourseRequest
    {
        public virtual string secUUID { get; set; }
        public virtual bool include_crosslist { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class GradeByCourseResponse
    {
        public GradeByCourseResponse()
        {
            studentAcademicCredentials = new List<StudentAcademicCredentialAndStudentResponse>{};
            studentAcademicCredentialRetakes = new List<StudentAcademicCredentialAndStudentResponse>{};
            studentAcademicCredentialExtensions = new List<StudentAcademicCredentialExtensionResponse>{};
            validGrades = new List<GradeResponse>{};
        }

        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string secUUID { get; set; }
        public virtual DateTime? gradingEndDate { get; set; }
        public virtual DateTime? overrideGradingEndDate { get; set; }
        public virtual string course_name { get; set; }
        public virtual string title { get; set; }
        public virtual string term { get; set; }
        public virtual bool crosslists_included { get; set; }
        public virtual bool has_crosslists { get; set; }
        public virtual List<StudentAcademicCredentialAndStudentResponse> studentAcademicCredentials { get; set; }
        public virtual List<StudentAcademicCredentialAndStudentResponse> studentAcademicCredentialRetakes { get; set; }
        public virtual List<StudentAcademicCredentialExtensionResponse> studentAcademicCredentialExtensions { get; set; }
        public virtual List<GradeResponse> validGrades { get; set; }
    }

    public partial class GradeResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int id { get; set; }
        public virtual string grade_code { get; set; }
        public virtual string grade_name { get; set; }
        public virtual decimal grade_points { get; set; }
        public virtual bool gpa_credit { get; set; }
        public virtual bool completed_credit { get; set; }
    }

    public partial class InstructorResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string regent_login { get; set; }
        public virtual string preferred_name { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string full_name { get; set; }
        public virtual string email { get; set; }
        public virtual string image_base64 { get; set; }
    }

    public partial class StudentAcademicCredentialAndStudentResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual string uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string student_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string first_name { get; set; }
        public virtual string current_program { get; set; }
        public virtual string applied_to_graduate_from_programs { get; set; }
        public virtual string additional_instructors { get; set; }
        public virtual string stac_uuid { get; set; }
        public virtual int? section_id { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string subject { get; set; }
        public virtual int? course_level { get; set; }
        public virtual string title { get; set; }
        public virtual string location { get; set; }
        public virtual bool is_audio { get; set; }
        public virtual decimal? credit_value { get; set; }
        public virtual decimal? audit_value { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_pass_fail { get; set; }
        public virtual string grade { get; set; }
        public virtual bool is_grade_final { get; set; }
        public virtual decimal? gpa_credits { get; set; }
        public virtual decimal? grade_points { get; set; }
        public virtual string academic_level { get; set; }
        public virtual string printed_comments { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual int? reporting_year { get; set; }
        public virtual string current_status { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string changed_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
    }

    public partial class StudentAcademicCredentialExtensionResponse
    {
        public StudentAcademicCredentialExtensionResponse()
        {
            instructors = new List<InstructorResponse>{};
        }

        public virtual string uuid { get; set; }
        public virtual string stac_uuid { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string course_name { get; set; }
        public virtual string section_code { get; set; }
        public virtual string location_code { get; set; }
        public virtual string title { get; set; }
        public virtual string term { get; set; }
        public virtual string reporting_term { get; set; }
        public virtual bool is_audit { get; set; }
        public virtual bool is_active { get; set; }
        public virtual decimal amount { get; set; }
        public virtual List<InstructorResponse> instructors { get; set; }
        public virtual DateTime? due_date { get; set; }
        public virtual DateTime? received_date { get; set; }
        public virtual string grade_penalty { get; set; }
        public virtual string assignments { get; set; }
        public virtual string comments { get; set; }
        public virtual DateTime? added_date { get; set; }
        public virtual string added_by { get; set; }
        public virtual DateTime? changed_date { get; set; }
        public virtual string changed_by { get; set; }
    }

}

C# GradeByCourseRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"secUUID":"String","include_crosslist":false}

HTTP/1.1 200 OK
Content-Type: text/csv
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}]}