regis

<back to all web services

StudentTransferCredentialsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/StudentTransferCredentials/{uuid}
import 'package:servicestack/servicestack.dart';

class InstitutionResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? institution_id;
    String? institution_name;
    String? institution_previous_names;
    String? institution_other_names;
    String? institution_type;
    String? accreditation_status;
    String? accreditation_status_notes;
    List<String>? related_institutions;
    DateTime? accreditation_status_changed_date;
    String? gpa_conversion;
    String? credit_hour_conversion;
    String? addr1;
    String? addr2;
    String? city;
    String? state;
    String? country;
    String? zip;

    InstitutionResponse({this.responseStatus,this.institution_id,this.institution_name,this.institution_previous_names,this.institution_other_names,this.institution_type,this.accreditation_status,this.accreditation_status_notes,this.related_institutions,this.accreditation_status_changed_date,this.gpa_conversion,this.credit_hour_conversion,this.addr1,this.addr2,this.city,this.state,this.country,this.zip});
    InstitutionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        institution_id = json['institution_id'];
        institution_name = json['institution_name'];
        institution_previous_names = json['institution_previous_names'];
        institution_other_names = json['institution_other_names'];
        institution_type = json['institution_type'];
        accreditation_status = json['accreditation_status'];
        accreditation_status_notes = json['accreditation_status_notes'];
        related_institutions = JsonConverters.fromJson(json['related_institutions'],'List<String>',context!);
        accreditation_status_changed_date = JsonConverters.fromJson(json['accreditation_status_changed_date'],'DateTime',context!);
        gpa_conversion = json['gpa_conversion'];
        credit_hour_conversion = json['credit_hour_conversion'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        city = json['city'];
        state = json['state'];
        country = json['country'];
        zip = json['zip'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'institution_id': institution_id,
        'institution_name': institution_name,
        'institution_previous_names': institution_previous_names,
        'institution_other_names': institution_other_names,
        'institution_type': institution_type,
        'accreditation_status': accreditation_status,
        'accreditation_status_notes': accreditation_status_notes,
        'related_institutions': JsonConverters.toJson(related_institutions,'List<String>',context!),
        'accreditation_status_changed_date': JsonConverters.toJson(accreditation_status_changed_date,'DateTime',context!),
        'gpa_conversion': gpa_conversion,
        'credit_hour_conversion': credit_hour_conversion,
        'addr1': addr1,
        'addr2': addr2,
        'city': city,
        'state': state,
        'country': country,
        'zip': zip
    };

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

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 StudentTransferCredentialResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? uuid;
    String? stran_uuid;
    String? course_name;
    String? title;
    double? credit_value;
    bool? is_advanced_standing;
    int? equivalent_id;
    int? institution_id;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;

    StudentTransferCredentialResponse({this.responseStatus,this.uuid,this.stran_uuid,this.course_name,this.title,this.credit_value,this.is_advanced_standing,this.equivalent_id,this.institution_id,this.added_by,this.added_date,this.changed_by,this.changed_date});
    StudentTransferCredentialResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        uuid = json['uuid'];
        stran_uuid = json['stran_uuid'];
        course_name = json['course_name'];
        title = json['title'];
        credit_value = JsonConverters.toDouble(json['credit_value']);
        is_advanced_standing = json['is_advanced_standing'];
        equivalent_id = json['equivalent_id'];
        institution_id = json['institution_id'];
        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,
        'stran_uuid': stran_uuid,
        'course_name': course_name,
        'title': title,
        'credit_value': credit_value,
        'is_advanced_standing': is_advanced_standing,
        'equivalent_id': equivalent_id,
        'institution_id': institution_id,
        '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() => "StudentTransferCredentialResponse";
    TypeContext? context = _ctx;
}

class StudentTransferCredentialPackageResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? equivalent_id;
    bool? is_advanced_standing;
    InstitutionResponse? institution;
    List<StudentAcademicCredentialResponse>? studentAcademicCredentials;
    List<StudentTransferCredentialResponse>? studentTransferCredentials;

    StudentTransferCredentialPackageResponse({this.responseStatus,this.equivalent_id,this.is_advanced_standing,this.institution,this.studentAcademicCredentials,this.studentTransferCredentials});
    StudentTransferCredentialPackageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        equivalent_id = json['equivalent_id'];
        is_advanced_standing = json['is_advanced_standing'];
        institution = JsonConverters.fromJson(json['institution'],'InstitutionResponse',context!);
        studentAcademicCredentials = JsonConverters.fromJson(json['studentAcademicCredentials'],'List<StudentAcademicCredentialResponse>',context!);
        studentTransferCredentials = JsonConverters.fromJson(json['studentTransferCredentials'],'List<StudentTransferCredentialResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'equivalent_id': equivalent_id,
        'is_advanced_standing': is_advanced_standing,
        'institution': JsonConverters.toJson(institution,'InstitutionResponse',context!),
        'studentAcademicCredentials': JsonConverters.toJson(studentAcademicCredentials,'List<StudentAcademicCredentialResponse>',context!),
        'studentTransferCredentials': JsonConverters.toJson(studentTransferCredentials,'List<StudentTransferCredentialResponse>',context!)
    };

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

class StudentTransferCredentialsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    List<StudentTransferCredentialPackageResponse>? studentTransferCredentialPackage;

    StudentTransferCredentialsResponse({this.responseStatus,this.regent_id,this.uuid,this.studentTransferCredentialPackage});
    StudentTransferCredentialsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        studentTransferCredentialPackage = JsonConverters.fromJson(json['studentTransferCredentialPackage'],'List<StudentTransferCredentialPackageResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'studentTransferCredentialPackage': JsonConverters.toJson(studentTransferCredentialPackage,'List<StudentTransferCredentialPackageResponse>',context!)
    };

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

class StudentTransferCredentialsRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'InstitutionResponse': TypeInfo(TypeOf.Class, create:() => InstitutionResponse()),
    'StudentAcademicCredentialResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialResponse()),
    'StudentTransferCredentialResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialResponse()),
    'StudentTransferCredentialPackageResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialPackageResponse()),
    'List<StudentAcademicCredentialResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialResponse>[]),
    'List<StudentTransferCredentialResponse>': TypeInfo(TypeOf.Class, create:() => <StudentTransferCredentialResponse>[]),
    'StudentTransferCredentialsResponse': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialsResponse()),
    'List<StudentTransferCredentialPackageResponse>': TypeInfo(TypeOf.Class, create:() => <StudentTransferCredentialPackageResponse>[]),
    'StudentTransferCredentialsRequest': TypeInfo(TypeOf.Class, create:() => StudentTransferCredentialsRequest()),
});

Dart StudentTransferCredentialsRequest 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 /StudentTransferCredentials/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: 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
		}
	},
	regent_id: 0,
	uuid: String,
	studentTransferCredentialPackage: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			equivalent_id: 0,
			is_advanced_standing: False,
			institution: 
			{
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				institution_id: 0,
				institution_name: String,
				institution_previous_names: String,
				institution_other_names: String,
				institution_type: String,
				accreditation_status: String,
				accreditation_status_notes: String,
				related_institutions: 
				[
					String
				],
				accreditation_status_changed_date: 0001-01-01,
				gpa_conversion: String,
				credit_hour_conversion: String,
				addr1: String,
				addr2: String,
				city: String,
				state: String,
				country: String,
				zip: String
			},
			studentAcademicCredentials: 
			[
				{
					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
				}
			],
			studentTransferCredentials: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					uuid: String,
					stran_uuid: String,
					course_name: String,
					title: String,
					credit_value: 0,
					is_advanced_standing: False,
					equivalent_id: 0,
					institution_id: 0,
					added_by: String,
					added_date: 0001-01-01,
					changed_by: String,
					changed_date: 0001-01-01
				}
			]
		}
	]
}