regis

<back to all web services

RecentRegistrationRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/registration/recent
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class PersonSimpleResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    int? ubc_id;
    String? uuid;
    String? regent_login;
    String? first_name;
    String? preferred_name;
    String? middle_name;
    String? last_name;
    String? email;
    String? phone_home;
    String? phone_cell;
    String? phone_bus;
    String? addr1;
    String? addr2;
    String? city;
    String? state;
    String? country;
    String? code;
    String? citizenship;
    String? citizenship_other;
    String? permanent_resident;
    DateTime? dob;
    bool? is_student;
    bool? is_faculty;
    bool? is_vendor;

    PersonSimpleResponse({this.responseStatus,this.regent_id,this.ubc_id,this.uuid,this.regent_login,this.first_name,this.preferred_name,this.middle_name,this.last_name,this.email,this.phone_home,this.phone_cell,this.phone_bus,this.addr1,this.addr2,this.city,this.state,this.country,this.code,this.citizenship,this.citizenship_other,this.permanent_resident,this.dob,this.is_student,this.is_faculty,this.is_vendor});
    PersonSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        ubc_id = json['ubc_id'];
        uuid = json['uuid'];
        regent_login = json['regent_login'];
        first_name = json['first_name'];
        preferred_name = json['preferred_name'];
        middle_name = json['middle_name'];
        last_name = json['last_name'];
        email = json['email'];
        phone_home = json['phone_home'];
        phone_cell = json['phone_cell'];
        phone_bus = json['phone_bus'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        city = json['city'];
        state = json['state'];
        country = json['country'];
        code = json['code'];
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        is_student = json['is_student'];
        is_faculty = json['is_faculty'];
        is_vendor = json['is_vendor'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'ubc_id': ubc_id,
        'uuid': uuid,
        'regent_login': regent_login,
        'first_name': first_name,
        'preferred_name': preferred_name,
        'middle_name': middle_name,
        'last_name': last_name,
        'email': email,
        'phone_home': phone_home,
        'phone_cell': phone_cell,
        'phone_bus': phone_bus,
        'addr1': addr1,
        'addr2': addr2,
        'city': city,
        'state': state,
        'country': country,
        'code': code,
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'is_student': is_student,
        'is_faculty': is_faculty,
        'is_vendor': is_vendor
    };

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

class StudentAcademicCredentialSimpleResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? course_uuid;
    String? course_name;
    String? section_code;
    int? section_id;
    String? term;
    String? reporting_term;
    String? title;
    double? amount;
    bool? is_audit;
    bool? is_pass_fail;
    bool? is_graded;

    StudentAcademicCredentialSimpleResponse({this.responseStatus,this.course_uuid,this.course_name,this.section_code,this.section_id,this.term,this.reporting_term,this.title,this.amount,this.is_audit,this.is_pass_fail,this.is_graded});
    StudentAcademicCredentialSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        course_uuid = json['course_uuid'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        section_id = json['section_id'];
        term = json['term'];
        reporting_term = json['reporting_term'];
        title = json['title'];
        amount = JsonConverters.toDouble(json['amount']);
        is_audit = json['is_audit'];
        is_pass_fail = json['is_pass_fail'];
        is_graded = json['is_graded'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'course_uuid': course_uuid,
        'course_name': course_name,
        'section_code': section_code,
        'section_id': section_id,
        'term': term,
        'reporting_term': reporting_term,
        'title': title,
        'amount': amount,
        'is_audit': is_audit,
        'is_pass_fail': is_pass_fail,
        'is_graded': is_graded
    };

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

class StudentAcademicCredentialByReportingTermSimpleResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? reportingTerm;
    double? onlineCreditsAttempted;
    double? onlineAuditsAttempted;
    List<StudentAcademicCredentialSimpleResponse>? studentAcademicCredentialSimpleResponse;

    StudentAcademicCredentialByReportingTermSimpleResponse({this.responseStatus,this.reportingTerm,this.onlineCreditsAttempted,this.onlineAuditsAttempted,this.studentAcademicCredentialSimpleResponse});
    StudentAcademicCredentialByReportingTermSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        reportingTerm = json['reportingTerm'];
        onlineCreditsAttempted = JsonConverters.toDouble(json['onlineCreditsAttempted']);
        onlineAuditsAttempted = JsonConverters.toDouble(json['onlineAuditsAttempted']);
        studentAcademicCredentialSimpleResponse = JsonConverters.fromJson(json['studentAcademicCredentialSimpleResponse'],'List<StudentAcademicCredentialSimpleResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'reportingTerm': reportingTerm,
        'onlineCreditsAttempted': onlineCreditsAttempted,
        'onlineAuditsAttempted': onlineAuditsAttempted,
        'studentAcademicCredentialSimpleResponse': JsonConverters.toJson(studentAcademicCredentialSimpleResponse,'List<StudentAcademicCredentialSimpleResponse>',context!)
    };

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

class RegistrationDocumentResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    String? first_name;
    String? last_name;
    String? gender;
    String? email;
    String? program;
    String? concentration;
    String? section_uuid;
    String? course_name;
    String? course_title;
    String? reporting_term;
    String? document_code;
    String? document_json;
    String? document_name;
    String? document_description;
    DateTime? added_date;
    DateTime? changed_date;

    RegistrationDocumentResponse({this.uuid,this.regent_id,this.first_name,this.last_name,this.gender,this.email,this.program,this.concentration,this.section_uuid,this.course_name,this.course_title,this.reporting_term,this.document_code,this.document_json,this.document_name,this.document_description,this.added_date,this.changed_date});
    RegistrationDocumentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        gender = json['gender'];
        email = json['email'];
        program = json['program'];
        concentration = json['concentration'];
        section_uuid = json['section_uuid'];
        course_name = json['course_name'];
        course_title = json['course_title'];
        reporting_term = json['reporting_term'];
        document_code = json['document_code'];
        document_json = json['document_json'];
        document_name = json['document_name'];
        document_description = json['document_description'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'gender': gender,
        'email': email,
        'program': program,
        'concentration': concentration,
        'section_uuid': section_uuid,
        'course_name': course_name,
        'course_title': course_title,
        'reporting_term': reporting_term,
        'document_code': document_code,
        'document_json': document_json,
        'document_name': document_name,
        'document_description': document_description,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
    };

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

class ProvisionalRegistrationResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    String? student_name;
    String? email;
    String? section_uuid;
    String? student_section_uuid;
    String? course_name;
    String? section_code;
    String? title;
    String? term;
    double? amount;
    bool? is_audit;
    bool? is_waitlist;
    bool? is_missing_requisites;
    bool? is_other_restriction;
    List<RegistrationDocumentResponse>? documents;
    DateTime? requested_date;

    ProvisionalRegistrationResponse({this.uuid,this.regent_id,this.student_name,this.email,this.section_uuid,this.student_section_uuid,this.course_name,this.section_code,this.title,this.term,this.amount,this.is_audit,this.is_waitlist,this.is_missing_requisites,this.is_other_restriction,this.documents,this.requested_date});
    ProvisionalRegistrationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        student_name = json['student_name'];
        email = json['email'];
        section_uuid = json['section_uuid'];
        student_section_uuid = json['student_section_uuid'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        title = json['title'];
        term = json['term'];
        amount = JsonConverters.toDouble(json['amount']);
        is_audit = json['is_audit'];
        is_waitlist = json['is_waitlist'];
        is_missing_requisites = json['is_missing_requisites'];
        is_other_restriction = json['is_other_restriction'];
        documents = JsonConverters.fromJson(json['documents'],'List<RegistrationDocumentResponse>',context!);
        requested_date = JsonConverters.fromJson(json['requested_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'student_name': student_name,
        'email': email,
        'section_uuid': section_uuid,
        'student_section_uuid': student_section_uuid,
        'course_name': course_name,
        'section_code': section_code,
        'title': title,
        'term': term,
        'amount': amount,
        'is_audit': is_audit,
        'is_waitlist': is_waitlist,
        'is_missing_requisites': is_missing_requisites,
        'is_other_restriction': is_other_restriction,
        'documents': JsonConverters.toJson(documents,'List<RegistrationDocumentResponse>',context!),
        'requested_date': JsonConverters.toJson(requested_date,'DateTime',context!)
    };

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

class ProvisionalRegistrationsForStudentResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    List<ProvisionalRegistrationResponse>? provisional_registrations;

    ProvisionalRegistrationsForStudentResponse({this.responseStatus,this.regent_id,this.uuid,this.provisional_registrations});
    ProvisionalRegistrationsForStudentResponse.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'];
        provisional_registrations = JsonConverters.fromJson(json['provisional_registrations'],'List<ProvisionalRegistrationResponse>',context!);
        return this;
    }

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

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

class RegistrationSummaryResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    bool? is_missing_tax_number;
    PersonSimpleResponse? person;
    List<StudentAcademicCredentialByReportingTermSimpleResponse>? registrations;
    ProvisionalRegistrationsForStudentResponse? provisional_registrations;

    RegistrationSummaryResponse({this.responseStatus,this.regent_id,this.uuid,this.is_missing_tax_number,this.person,this.registrations,this.provisional_registrations});
    RegistrationSummaryResponse.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'];
        is_missing_tax_number = json['is_missing_tax_number'];
        person = JsonConverters.fromJson(json['person'],'PersonSimpleResponse',context!);
        registrations = JsonConverters.fromJson(json['registrations'],'List<StudentAcademicCredentialByReportingTermSimpleResponse>',context!);
        provisional_registrations = JsonConverters.fromJson(json['provisional_registrations'],'ProvisionalRegistrationsForStudentResponse',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'is_missing_tax_number': is_missing_tax_number,
        'person': JsonConverters.toJson(person,'PersonSimpleResponse',context!),
        'registrations': JsonConverters.toJson(registrations,'List<StudentAcademicCredentialByReportingTermSimpleResponse>',context!),
        'provisional_registrations': JsonConverters.toJson(provisional_registrations,'ProvisionalRegistrationsForStudentResponse',context!)
    };

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

class RecentRegistrationRequest implements IConvertible
{
    String? uuid;
    String? from_this_term;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'PersonSimpleResponse': TypeInfo(TypeOf.Class, create:() => PersonSimpleResponse()),
    'StudentAcademicCredentialSimpleResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialSimpleResponse()),
    'StudentAcademicCredentialByReportingTermSimpleResponse': TypeInfo(TypeOf.Class, create:() => StudentAcademicCredentialByReportingTermSimpleResponse()),
    'List<StudentAcademicCredentialSimpleResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialSimpleResponse>[]),
    'RegistrationDocumentResponse': TypeInfo(TypeOf.Class, create:() => RegistrationDocumentResponse()),
    'ProvisionalRegistrationResponse': TypeInfo(TypeOf.Class, create:() => ProvisionalRegistrationResponse()),
    'List<RegistrationDocumentResponse>': TypeInfo(TypeOf.Class, create:() => <RegistrationDocumentResponse>[]),
    'ProvisionalRegistrationsForStudentResponse': TypeInfo(TypeOf.Class, create:() => ProvisionalRegistrationsForStudentResponse()),
    'List<ProvisionalRegistrationResponse>': TypeInfo(TypeOf.Class, create:() => <ProvisionalRegistrationResponse>[]),
    'RegistrationSummaryResponse': TypeInfo(TypeOf.Class, create:() => RegistrationSummaryResponse()),
    'List<StudentAcademicCredentialByReportingTermSimpleResponse>': TypeInfo(TypeOf.Class, create:() => <StudentAcademicCredentialByReportingTermSimpleResponse>[]),
    'RecentRegistrationRequest': TypeInfo(TypeOf.Class, create:() => RecentRegistrationRequest()),
});

Dart RecentRegistrationRequest 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 /registration/recent HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	from_this_term: 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,
	is_missing_tax_number: False,
	person: 
	{
		responseStatus: 
		{
			errorCode: String,
			message: String,
			stackTrace: String,
			errors: 
			[
				{
					errorCode: String,
					fieldName: String,
					message: String,
					meta: 
					{
						String: String
					}
				}
			],
			meta: 
			{
				String: String
			}
		},
		regent_id: 0,
		ubc_id: 0,
		uuid: String,
		regent_login: String,
		first_name: String,
		preferred_name: String,
		middle_name: String,
		last_name: String,
		email: String,
		phone_home: String,
		phone_cell: String,
		phone_bus: String,
		addr1: String,
		addr2: String,
		city: String,
		state: String,
		country: String,
		code: String,
		citizenship: String,
		citizenship_other: String,
		permanent_resident: String,
		dob: 0001-01-01,
		is_student: False,
		is_faculty: False,
		is_vendor: False
	},
	registrations: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			reportingTerm: String,
			onlineCreditsAttempted: 0,
			onlineAuditsAttempted: 0,
			studentAcademicCredentialSimpleResponse: 
			[
				{
					responseStatus: 
					{
						errorCode: String,
						message: String,
						stackTrace: String,
						errors: 
						[
							{
								errorCode: String,
								fieldName: String,
								message: String,
								meta: 
								{
									String: String
								}
							}
						],
						meta: 
						{
							String: String
						}
					},
					course_uuid: String,
					course_name: String,
					section_code: String,
					section_id: 0,
					term: String,
					reporting_term: String,
					title: String,
					amount: 0,
					is_audit: False,
					is_pass_fail: False,
					is_graded: False
				}
			]
		}
	],
	provisional_registrations: 
	{
		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,
		provisional_registrations: 
		[
			{
				uuid: String,
				regent_id: 0,
				student_name: String,
				email: String,
				section_uuid: String,
				student_section_uuid: String,
				course_name: String,
				section_code: String,
				title: String,
				term: String,
				amount: 0,
				is_audit: False,
				is_waitlist: False,
				is_missing_requisites: False,
				is_other_restriction: False,
				documents: 
				[
					{
						uuid: String,
						regent_id: 0,
						first_name: String,
						last_name: String,
						gender: String,
						email: String,
						program: String,
						concentration: String,
						section_uuid: String,
						course_name: String,
						course_title: String,
						reporting_term: String,
						document_code: String,
						document_json: String,
						document_name: String,
						document_description: String,
						added_date: 0001-01-01,
						changed_date: 0001-01-01
					}
				],
				requested_date: 0001-01-01
			}
		]
	}
}