regis

<back to all web services

ProvisionalRegistrationsForStudentRequest

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

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 ProvisionalRegistrationsForStudentRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    '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>[]),
    'ProvisionalRegistrationsForStudentRequest': TypeInfo(TypeOf.Class, create:() => ProvisionalRegistrationsForStudentRequest()),
});

Dart ProvisionalRegistrationsForStudentRequest 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/{uuid}/Provisional 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,
	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
		}
	]
}