regis

<back to all web services

ShareMyGradesReportRequest

Requires Authentication
Required permission:ShareGrades
The following routes are available for this service:
POST/ShareMyGrades/Report/{token}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class StudentAcademicCredentialResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    String? stac_uuid;
    int? section_id;
    String? course_name;
    String? section_code;
    String? subject;
    int? course_level;
    String? title;
    String? pretty_title;
    String? location;
    bool? is_audio;
    bool? is_oncampus;
    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;

    StudentAcademicCredentialResponse({this.responseStatus,this.uuid,this.stac_uuid,this.section_id,this.course_name,this.section_code,this.subject,this.course_level,this.title,this.pretty_title,this.location,this.is_audio,this.is_oncampus,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});
    StudentAcademicCredentialResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        uuid = json['uuid'];
        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'];
        pretty_title = json['pretty_title'];
        location = json['location'];
        is_audio = json['is_audio'];
        is_oncampus = json['is_oncampus'];
        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,
        'stac_uuid': stac_uuid,
        'section_id': section_id,
        'course_name': course_name,
        'section_code': section_code,
        'subject': subject,
        'course_level': course_level,
        'title': title,
        'pretty_title': pretty_title,
        'location': location,
        'is_audio': is_audio,
        'is_oncampus': is_oncampus,
        '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() => "StudentAcademicCredentialResponse";
    TypeContext? context = _ctx;
}

class StudentAcademicCredentialTranscriptResponse extends StudentAcademicCredentialResponse implements IConvertible
{
    double? registered_credits;

    StudentAcademicCredentialTranscriptResponse({this.registered_credits});
    StudentAcademicCredentialTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        registered_credits = JsonConverters.toDouble(json['registered_credits']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'registered_credits': registered_credits
    });

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

class StudentTransferCredentialTranscriptResponse implements IConvertible
{
    String? course_name;
    String? title;
    bool? is_advanced_standing;
    double? credit_value;

    StudentTransferCredentialTranscriptResponse({this.course_name,this.title,this.is_advanced_standing,this.credit_value});
    StudentTransferCredentialTranscriptResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        course_name = json['course_name'];
        title = json['title'];
        is_advanced_standing = json['is_advanced_standing'];
        credit_value = JsonConverters.toDouble(json['credit_value']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'course_name': course_name,
        'title': title,
        'is_advanced_standing': is_advanced_standing,
        'credit_value': credit_value
    };

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

class ShareMyGradesReportResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? first_name;
    String? last_name;
    int? regent_id;
    double? gpa;
    String? current_program;
    List<StudentAcademicCredentialTranscriptResponse>? student_academic_credentials;
    List<StudentTransferCredentialTranscriptResponse>? transfer_credentials;

    ShareMyGradesReportResponse({this.responseStatus,this.first_name,this.last_name,this.regent_id,this.gpa,this.current_program,this.student_academic_credentials,this.transfer_credentials});
    ShareMyGradesReportResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        first_name = json['first_name'];
        last_name = json['last_name'];
        regent_id = json['regent_id'];
        gpa = JsonConverters.toDouble(json['gpa']);
        current_program = json['current_program'];
        student_academic_credentials = JsonConverters.fromJson(json['student_academic_credentials'],'List<StudentAcademicCredentialTranscriptResponse>',context!);
        transfer_credentials = JsonConverters.fromJson(json['transfer_credentials'],'List<StudentTransferCredentialTranscriptResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'first_name': first_name,
        'last_name': last_name,
        'regent_id': regent_id,
        'gpa': gpa,
        'current_program': current_program,
        'student_academic_credentials': JsonConverters.toJson(student_academic_credentials,'List<StudentAcademicCredentialTranscriptResponse>',context!),
        'transfer_credentials': JsonConverters.toJson(transfer_credentials,'List<StudentTransferCredentialTranscriptResponse>',context!)
    };

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

class ShareMyGradesReportRequest implements IConvertible
{
    String? token;

    ShareMyGradesReportRequest({this.token});
    ShareMyGradesReportRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'StudentAcademicCredentialResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialResponse()),
    'StudentAcademicCredentialTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialTranscriptResponse()),
    'StudentTransferCredentialTranscriptResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialTranscriptResponse()),
    'ShareMyGradesReportResponse': TypeInfo(TypeOf.Class, create:() => ShareMyGradesReportResponse()),
    'List<StudentAcademicCredentialTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialTranscriptResponse>[]),
    'List<StudentTransferCredentialTranscriptResponse>': TypeInfo(TypeOf.Class, create:() => <StudentTransferCredentialTranscriptResponse>[]),
    'ShareMyGradesReportRequest': TypeInfo(TypeOf.Class, create:() => ShareMyGradesReportRequest()),
});

Dart ShareMyGradesReportRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ShareMyGrades/Report/{token} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	first_name: String,
	last_name: String,
	regent_id: 0,
	gpa: 0,
	current_program: String,
	student_academic_credentials: 
	[
		{
			registered_credits: 0,
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			uuid: String,
			stac_uuid: String,
			section_id: 0,
			course_name: String,
			section_code: String,
			subject: String,
			course_level: 0,
			title: String,
			pretty_title: String,
			location: String,
			is_audio: False,
			is_oncampus: 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-01,
			changed_by: String,
			changed_date: 0001-01-01
		}
	],
	transfer_credentials: 
	[
		{
			course_name: String,
			title: String,
			is_advanced_standing: False,
			credit_value: 0
		}
	]
}