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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class StudentAcademicCredentialAndStudentResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    int? regent_id;
    String? student_name;
    String? last_name;
    String? first_name;
    String? current_program;
    String? applied_to_graduate_from_programs;
    String? additional_instructors;
    String? stac_uuid;
    int? section_id;
    String? course_name;
    String? section_code;
    String? subject;
    int? course_level;
    String? title;
    String? location;
    bool? is_audio;
    double? credit_value;
    double? audit_value;
    bool? is_audit;
    bool? is_pass_fail;
    String? grade;
    bool? is_grade_final;
    double? gpa_credits;
    double? grade_points;
    String? academic_level;
    String? printed_comments;
    String? term;
    String? reporting_term;
    int? reporting_year;
    String? current_status;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;

    StudentAcademicCredentialAndStudentResponse({this.responseStatus,this.uuid,this.regent_id,this.student_name,this.last_name,this.first_name,this.current_program,this.applied_to_graduate_from_programs,this.additional_instructors,this.stac_uuid,this.section_id,this.course_name,this.section_code,this.subject,this.course_level,this.title,this.location,this.is_audio,this.credit_value,this.audit_value,this.is_audit,this.is_pass_fail,this.grade,this.is_grade_final,this.gpa_credits,this.grade_points,this.academic_level,this.printed_comments,this.term,this.reporting_term,this.reporting_year,this.current_status,this.added_by,this.added_date,this.changed_by,this.changed_date});
    StudentAcademicCredentialAndStudentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        student_name = json['student_name'];
        last_name = json['last_name'];
        first_name = json['first_name'];
        current_program = json['current_program'];
        applied_to_graduate_from_programs = json['applied_to_graduate_from_programs'];
        additional_instructors = json['additional_instructors'];
        stac_uuid = json['stac_uuid'];
        section_id = json['section_id'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        subject = json['subject'];
        course_level = json['course_level'];
        title = json['title'];
        location = json['location'];
        is_audio = json['is_audio'];
        credit_value = JsonConverters.toDouble(json['credit_value']);
        audit_value = JsonConverters.toDouble(json['audit_value']);
        is_audit = json['is_audit'];
        is_pass_fail = json['is_pass_fail'];
        grade = json['grade'];
        is_grade_final = json['is_grade_final'];
        gpa_credits = JsonConverters.toDouble(json['gpa_credits']);
        grade_points = JsonConverters.toDouble(json['grade_points']);
        academic_level = json['academic_level'];
        printed_comments = json['printed_comments'];
        term = json['term'];
        reporting_term = json['reporting_term'];
        reporting_year = json['reporting_year'];
        current_status = json['current_status'];
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'uuid': uuid,
        'regent_id': regent_id,
        'student_name': student_name,
        'last_name': last_name,
        'first_name': first_name,
        'current_program': current_program,
        'applied_to_graduate_from_programs': applied_to_graduate_from_programs,
        'additional_instructors': additional_instructors,
        'stac_uuid': stac_uuid,
        'section_id': section_id,
        'course_name': course_name,
        'section_code': section_code,
        'subject': subject,
        'course_level': course_level,
        'title': title,
        'location': location,
        'is_audio': is_audio,
        'credit_value': credit_value,
        'audit_value': audit_value,
        'is_audit': is_audit,
        'is_pass_fail': is_pass_fail,
        'grade': grade,
        'is_grade_final': is_grade_final,
        'gpa_credits': gpa_credits,
        'grade_points': grade_points,
        'academic_level': academic_level,
        'printed_comments': printed_comments,
        'term': term,
        'reporting_term': reporting_term,
        'reporting_year': reporting_year,
        'current_status': current_status,
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_by': changed_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
    };

    getTypeName() => "StudentAcademicCredentialAndStudentResponse";
    TypeContext? context = _ctx;
}

class InstructorResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? regent_login;
    String? preferred_name;
    String? first_name;
    String? last_name;
    String? full_name;
    String? email;
    String? image_base64;

    InstructorResponse({this.responseStatus,this.regent_id,this.regent_login,this.preferred_name,this.first_name,this.last_name,this.full_name,this.email,this.image_base64});
    InstructorResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        regent_login = json['regent_login'];
        preferred_name = json['preferred_name'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        full_name = json['full_name'];
        email = json['email'];
        image_base64 = json['image_base64'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'regent_login': regent_login,
        'preferred_name': preferred_name,
        'first_name': first_name,
        'last_name': last_name,
        'full_name': full_name,
        'email': email,
        'image_base64': image_base64
    };

    getTypeName() => "InstructorResponse";
    TypeContext? context = _ctx;
}

class StudentAcademicCredentialExtensionResponse implements IConvertible
{
    String? uuid;
    String? stac_uuid;
    int? regent_id;
    String? first_name;
    String? last_name;
    String? course_name;
    String? section_code;
    String? location_code;
    String? title;
    String? term;
    String? reporting_term;
    bool? is_audit;
    bool? is_active;
    double? amount;
    List<InstructorResponse>? instructors;
    DateTime? due_date;
    DateTime? received_date;
    String? grade_penalty;
    String? assignments;
    String? comments;
    DateTime? added_date;
    String? added_by;
    DateTime? changed_date;
    String? changed_by;

    StudentAcademicCredentialExtensionResponse({this.uuid,this.stac_uuid,this.regent_id,this.first_name,this.last_name,this.course_name,this.section_code,this.location_code,this.title,this.term,this.reporting_term,this.is_audit,this.is_active,this.amount,this.instructors,this.due_date,this.received_date,this.grade_penalty,this.assignments,this.comments,this.added_date,this.added_by,this.changed_date,this.changed_by});
    StudentAcademicCredentialExtensionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        stac_uuid = json['stac_uuid'];
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        location_code = json['location_code'];
        title = json['title'];
        term = json['term'];
        reporting_term = json['reporting_term'];
        is_audit = json['is_audit'];
        is_active = json['is_active'];
        amount = JsonConverters.toDouble(json['amount']);
        instructors = JsonConverters.fromJson(json['instructors'],'List<InstructorResponse>',context!);
        due_date = JsonConverters.fromJson(json['due_date'],'DateTime',context!);
        received_date = JsonConverters.fromJson(json['received_date'],'DateTime',context!);
        grade_penalty = json['grade_penalty'];
        assignments = json['assignments'];
        comments = json['comments'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        added_by = json['added_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'stac_uuid': stac_uuid,
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'course_name': course_name,
        'section_code': section_code,
        'location_code': location_code,
        'title': title,
        'term': term,
        'reporting_term': reporting_term,
        'is_audit': is_audit,
        'is_active': is_active,
        'amount': amount,
        'instructors': JsonConverters.toJson(instructors,'List<InstructorResponse>',context!),
        'due_date': JsonConverters.toJson(due_date,'DateTime',context!),
        'received_date': JsonConverters.toJson(received_date,'DateTime',context!),
        'grade_penalty': grade_penalty,
        'assignments': assignments,
        'comments': comments,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'added_by': added_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
        'changed_by': changed_by
    };

    getTypeName() => "StudentAcademicCredentialExtensionResponse";
    TypeContext? context = _ctx;
}

class GradeResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? id;
    String? grade_code;
    String? grade_name;
    double? grade_points;
    bool? gpa_credit;
    bool? completed_credit;

    GradeResponse({this.responseStatus,this.id,this.grade_code,this.grade_name,this.grade_points,this.gpa_credit,this.completed_credit});
    GradeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        id = json['id'];
        grade_code = json['grade_code'];
        grade_name = json['grade_name'];
        grade_points = JsonConverters.toDouble(json['grade_points']);
        gpa_credit = json['gpa_credit'];
        completed_credit = json['completed_credit'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'id': id,
        'grade_code': grade_code,
        'grade_name': grade_name,
        'grade_points': grade_points,
        'gpa_credit': gpa_credit,
        'completed_credit': completed_credit
    };

    getTypeName() => "GradeResponse";
    TypeContext? context = _ctx;
}

class GradeByCourseResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? secUUID;
    DateTime? gradingEndDate;
    DateTime? overrideGradingEndDate;
    String? course_name;
    String? title;
    String? term;
    bool? crosslists_included;
    bool? has_crosslists;
    List<StudentAcademicCredentialAndStudentResponse>? studentAcademicCredentials;
    List<StudentAcademicCredentialAndStudentResponse>? studentAcademicCredentialRetakes;
    List<StudentAcademicCredentialExtensionResponse>? studentAcademicCredentialExtensions;
    List<GradeResponse>? validGrades;

    GradeByCourseResponse({this.responseStatus,this.secUUID,this.gradingEndDate,this.overrideGradingEndDate,this.course_name,this.title,this.term,this.crosslists_included,this.has_crosslists,this.studentAcademicCredentials,this.studentAcademicCredentialRetakes,this.studentAcademicCredentialExtensions,this.validGrades});
    GradeByCourseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        secUUID = json['secUUID'];
        gradingEndDate = JsonConverters.fromJson(json['gradingEndDate'],'DateTime',context!);
        overrideGradingEndDate = JsonConverters.fromJson(json['overrideGradingEndDate'],'DateTime',context!);
        course_name = json['course_name'];
        title = json['title'];
        term = json['term'];
        crosslists_included = json['crosslists_included'];
        has_crosslists = json['has_crosslists'];
        studentAcademicCredentials = JsonConverters.fromJson(json['studentAcademicCredentials'],'List<StudentAcademicCredentialAndStudentResponse>',context!);
        studentAcademicCredentialRetakes = JsonConverters.fromJson(json['studentAcademicCredentialRetakes'],'List<StudentAcademicCredentialAndStudentResponse>',context!);
        studentAcademicCredentialExtensions = JsonConverters.fromJson(json['studentAcademicCredentialExtensions'],'List<StudentAcademicCredentialExtensionResponse>',context!);
        validGrades = JsonConverters.fromJson(json['validGrades'],'List<GradeResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'secUUID': secUUID,
        'gradingEndDate': JsonConverters.toJson(gradingEndDate,'DateTime',context!),
        'overrideGradingEndDate': JsonConverters.toJson(overrideGradingEndDate,'DateTime',context!),
        'course_name': course_name,
        'title': title,
        'term': term,
        'crosslists_included': crosslists_included,
        'has_crosslists': has_crosslists,
        'studentAcademicCredentials': JsonConverters.toJson(studentAcademicCredentials,'List<StudentAcademicCredentialAndStudentResponse>',context!),
        'studentAcademicCredentialRetakes': JsonConverters.toJson(studentAcademicCredentialRetakes,'List<StudentAcademicCredentialAndStudentResponse>',context!),
        'studentAcademicCredentialExtensions': JsonConverters.toJson(studentAcademicCredentialExtensions,'List<StudentAcademicCredentialExtensionResponse>',context!),
        'validGrades': JsonConverters.toJson(validGrades,'List<GradeResponse>',context!)
    };

    getTypeName() => "GradeByCourseResponse";
    TypeContext? context = _ctx;
}

class GradeByCourseRequest implements IConvertible
{
    String? secUUID;
    bool? include_crosslist;

    GradeByCourseRequest({this.secUUID,this.include_crosslist});
    GradeByCourseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        secUUID = json['secUUID'];
        include_crosslist = json['include_crosslist'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'secUUID': secUUID,
        'include_crosslist': include_crosslist
    };

    getTypeName() => "GradeByCourseRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'StudentAcademicCredentialAndStudentResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialAndStudentResponse()),
    'InstructorResponse': TypeInfo(TypeOf.Class, create:() => InstructorResponse()),
    'StudentAcademicCredentialExtensionResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialExtensionResponse()),
    'List<InstructorResponse>': TypeInfo(TypeOf.Class, create:() => <InstructorResponse>[]),
    'GradeResponse': TypeInfo(TypeOf.Class, create:() => GradeResponse()),
    'GradeByCourseResponse': TypeInfo(TypeOf.Class, create:() => GradeByCourseResponse()),
    'List<StudentAcademicCredentialAndStudentResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialAndStudentResponse>[]),
    'List<StudentAcademicCredentialExtensionResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialExtensionResponse>[]),
    'List<GradeResponse>': TypeInfo(TypeOf.Class, create:() => <GradeResponse>[]),
    'GradeByCourseRequest': TypeInfo(TypeOf.Class, create:() => GradeByCourseRequest()),
});

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