regis

<back to all web services

SectionsAdminRequest

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

class SectionAdminResponse implements IConvertible
{
    String? uuid;
    int? section_id;
    int? course_id;
    String? course_name;
    double? min_credits;
    double? max_credits;
    double? credit_increments;
    double? min_audits;
    double? max_audits;
    double? audit_increments;
    String? section_code;
    String? title;
    String? pretty_title;
    String? override_course_description;
    String? current_status;
    String? location;
    String? room;
    bool? is_audio;
    bool? is_oncampus;
    String? distance_ed_materials;
    DateTime? start_date;
    DateTime? end_date;
    DateTime? first_meeting_date;
    DateTime? last_meeting_date;
    String? meeting_days;
    String? start_times;
    String? end_times;
    bool? is_pass_fail;
    bool? is_weekend;
    bool? is_weekday;
    bool? is_evening;
    bool? is_waitlist;
    bool? has_special_requirements;
    String? special_requirements;
    bool? is_unlisted;
    int? capacity;
    double? flat_fee_amount;
    double? additional_fee_amount;
    DateTime? override_registration_start_date;
    DateTime? override_registration_end_date;
    DateTime? override_add_start_date;
    DateTime? override_add_end_date;
    DateTime? override_drop_start_date;
    DateTime? override_drop_end_date;
    DateTime? override_grading_end_date;
    String? term;
    String? reporting_term;
    int? reporting_year;
    DateTime? added_date;
    String? added_by;
    DateTime? changed_date;
    String? changed_by;
    DateTime? timestamp;

    SectionAdminResponse({this.uuid,this.section_id,this.course_id,this.course_name,this.min_credits,this.max_credits,this.credit_increments,this.min_audits,this.max_audits,this.audit_increments,this.section_code,this.title,this.pretty_title,this.override_course_description,this.current_status,this.location,this.room,this.is_audio,this.is_oncampus,this.distance_ed_materials,this.start_date,this.end_date,this.first_meeting_date,this.last_meeting_date,this.meeting_days,this.start_times,this.end_times,this.is_pass_fail,this.is_weekend,this.is_weekday,this.is_evening,this.is_waitlist,this.has_special_requirements,this.special_requirements,this.is_unlisted,this.capacity,this.flat_fee_amount,this.additional_fee_amount,this.override_registration_start_date,this.override_registration_end_date,this.override_add_start_date,this.override_add_end_date,this.override_drop_start_date,this.override_drop_end_date,this.override_grading_end_date,this.term,this.reporting_term,this.reporting_year,this.added_date,this.added_by,this.changed_date,this.changed_by,this.timestamp});
    SectionAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        section_id = json['section_id'];
        course_id = json['course_id'];
        course_name = json['course_name'];
        min_credits = JsonConverters.toDouble(json['min_credits']);
        max_credits = JsonConverters.toDouble(json['max_credits']);
        credit_increments = JsonConverters.toDouble(json['credit_increments']);
        min_audits = JsonConverters.toDouble(json['min_audits']);
        max_audits = JsonConverters.toDouble(json['max_audits']);
        audit_increments = JsonConverters.toDouble(json['audit_increments']);
        section_code = json['section_code'];
        title = json['title'];
        pretty_title = json['pretty_title'];
        override_course_description = json['override_course_description'];
        current_status = json['current_status'];
        location = json['location'];
        room = json['room'];
        is_audio = json['is_audio'];
        is_oncampus = json['is_oncampus'];
        distance_ed_materials = json['distance_ed_materials'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        first_meeting_date = JsonConverters.fromJson(json['first_meeting_date'],'DateTime',context!);
        last_meeting_date = JsonConverters.fromJson(json['last_meeting_date'],'DateTime',context!);
        meeting_days = json['meeting_days'];
        start_times = json['start_times'];
        end_times = json['end_times'];
        is_pass_fail = json['is_pass_fail'];
        is_weekend = json['is_weekend'];
        is_weekday = json['is_weekday'];
        is_evening = json['is_evening'];
        is_waitlist = json['is_waitlist'];
        has_special_requirements = json['has_special_requirements'];
        special_requirements = json['special_requirements'];
        is_unlisted = json['is_unlisted'];
        capacity = json['capacity'];
        flat_fee_amount = JsonConverters.toDouble(json['flat_fee_amount']);
        additional_fee_amount = JsonConverters.toDouble(json['additional_fee_amount']);
        override_registration_start_date = JsonConverters.fromJson(json['override_registration_start_date'],'DateTime',context!);
        override_registration_end_date = JsonConverters.fromJson(json['override_registration_end_date'],'DateTime',context!);
        override_add_start_date = JsonConverters.fromJson(json['override_add_start_date'],'DateTime',context!);
        override_add_end_date = JsonConverters.fromJson(json['override_add_end_date'],'DateTime',context!);
        override_drop_start_date = JsonConverters.fromJson(json['override_drop_start_date'],'DateTime',context!);
        override_drop_end_date = JsonConverters.fromJson(json['override_drop_end_date'],'DateTime',context!);
        override_grading_end_date = JsonConverters.fromJson(json['override_grading_end_date'],'DateTime',context!);
        term = json['term'];
        reporting_term = json['reporting_term'];
        reporting_year = json['reporting_year'];
        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'];
        timestamp = JsonConverters.fromJson(json['timestamp'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'section_id': section_id,
        'course_id': course_id,
        'course_name': course_name,
        'min_credits': min_credits,
        'max_credits': max_credits,
        'credit_increments': credit_increments,
        'min_audits': min_audits,
        'max_audits': max_audits,
        'audit_increments': audit_increments,
        'section_code': section_code,
        'title': title,
        'pretty_title': pretty_title,
        'override_course_description': override_course_description,
        'current_status': current_status,
        'location': location,
        'room': room,
        'is_audio': is_audio,
        'is_oncampus': is_oncampus,
        'distance_ed_materials': distance_ed_materials,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
        'first_meeting_date': JsonConverters.toJson(first_meeting_date,'DateTime',context!),
        'last_meeting_date': JsonConverters.toJson(last_meeting_date,'DateTime',context!),
        'meeting_days': meeting_days,
        'start_times': start_times,
        'end_times': end_times,
        'is_pass_fail': is_pass_fail,
        'is_weekend': is_weekend,
        'is_weekday': is_weekday,
        'is_evening': is_evening,
        'is_waitlist': is_waitlist,
        'has_special_requirements': has_special_requirements,
        'special_requirements': special_requirements,
        'is_unlisted': is_unlisted,
        'capacity': capacity,
        'flat_fee_amount': flat_fee_amount,
        'additional_fee_amount': additional_fee_amount,
        'override_registration_start_date': JsonConverters.toJson(override_registration_start_date,'DateTime',context!),
        'override_registration_end_date': JsonConverters.toJson(override_registration_end_date,'DateTime',context!),
        'override_add_start_date': JsonConverters.toJson(override_add_start_date,'DateTime',context!),
        'override_add_end_date': JsonConverters.toJson(override_add_end_date,'DateTime',context!),
        'override_drop_start_date': JsonConverters.toJson(override_drop_start_date,'DateTime',context!),
        'override_drop_end_date': JsonConverters.toJson(override_drop_end_date,'DateTime',context!),
        'override_grading_end_date': JsonConverters.toJson(override_grading_end_date,'DateTime',context!),
        'term': term,
        'reporting_term': reporting_term,
        'reporting_year': reporting_year,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'added_by': added_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
        'changed_by': changed_by,
        'timestamp': JsonConverters.toJson(timestamp,'DateTime',context!)
    };

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

class SectionsAdminResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? reporting_term;
    List<SectionAdminResponse>? sections;
    Map<int,List<SectionRateWithAmountResponse>?>? section_rates;
    Map<int,List<SectionRefundScheduleResponse>?>? section_refund_schedules;
    List<String>? locations;
    Map<int,List<InstructorResponse>?>? section_instructors;
    Map<int,List<String>?>? section_document_codes;
    Map<int,List<int>?>? crosslisted_sections;

    SectionsAdminResponse({this.responseStatus,this.reporting_term,this.sections,this.section_rates,this.section_refund_schedules,this.locations,this.section_instructors,this.section_document_codes,this.crosslisted_sections});
    SectionsAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        reporting_term = json['reporting_term'];
        sections = JsonConverters.fromJson(json['sections'],'List<SectionAdminResponse>',context!);
        section_rates = JsonConverters.fromJson(json['section_rates'],'Map<int,List<SectionRateWithAmountResponse>?>',context!);
        section_refund_schedules = JsonConverters.fromJson(json['section_refund_schedules'],'Map<int,List<SectionRefundScheduleResponse>?>',context!);
        locations = JsonConverters.fromJson(json['locations'],'List<String>',context!);
        section_instructors = JsonConverters.fromJson(json['section_instructors'],'Map<int,List<InstructorResponse>?>',context!);
        section_document_codes = JsonConverters.fromJson(json['section_document_codes'],'Map<int,List<String>?>',context!);
        crosslisted_sections = JsonConverters.fromJson(json['crosslisted_sections'],'Map<int,List<int>?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'reporting_term': reporting_term,
        'sections': JsonConverters.toJson(sections,'List<SectionAdminResponse>',context!),
        'section_rates': JsonConverters.toJson(section_rates,'Map<int,List<SectionRateWithAmountResponse>?>',context!),
        'section_refund_schedules': JsonConverters.toJson(section_refund_schedules,'Map<int,List<SectionRefundScheduleResponse>?>',context!),
        'locations': JsonConverters.toJson(locations,'List<String>',context!),
        'section_instructors': JsonConverters.toJson(section_instructors,'Map<int,List<InstructorResponse>?>',context!),
        'section_document_codes': JsonConverters.toJson(section_document_codes,'Map<int,List<String>?>',context!),
        'crosslisted_sections': JsonConverters.toJson(crosslisted_sections,'Map<int,List<int>?>',context!)
    };

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

class SectionsAdminRequest implements IConvertible
{
    String? reporting_term;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'SectionAdminResponse': TypeInfo(TypeOf.Class, create:() => SectionAdminResponse()),
    'SectionsAdminResponse': TypeInfo(TypeOf.Class, create:() => SectionsAdminResponse()),
    'List<SectionAdminResponse>': TypeInfo(TypeOf.Class, create:() => <SectionAdminResponse>[]),
    'Map<int,List<SectionRateWithAmountResponse>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<SectionRateWithAmountResponse>?>()),
    'List<SectionRateWithAmountResponse>': TypeInfo(TypeOf.Class, create:() => <SectionRateWithAmountResponse>[]),
    'SectionRateWithAmountResponse': TypeInfo(TypeOf.Class, create:() => SectionRateWithAmountResponse()),
    'Map<int,List<SectionRefundScheduleResponse>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<SectionRefundScheduleResponse>?>()),
    'List<SectionRefundScheduleResponse>': TypeInfo(TypeOf.Class, create:() => <SectionRefundScheduleResponse>[]),
    'SectionRefundScheduleResponse': TypeInfo(TypeOf.Class, create:() => SectionRefundScheduleResponse()),
    'Map<int,List<InstructorResponse>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<InstructorResponse>?>()),
    'List<InstructorResponse>': TypeInfo(TypeOf.Class, create:() => <InstructorResponse>[]),
    'InstructorResponse': TypeInfo(TypeOf.Class, create:() => InstructorResponse()),
    'Map<int,List<String>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<String>?>()),
    'Map<int,List<int>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<int>?>()),
    'SectionsAdminRequest': TypeInfo(TypeOf.Class, create:() => SectionsAdminRequest()),
});

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

{
	reporting_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
		}
	},
	reporting_term: String,
	sections: 
	[
		{
			uuid: String,
			section_id: 0,
			course_id: 0,
			course_name: String,
			min_credits: 0,
			max_credits: 0,
			credit_increments: 0,
			min_audits: 0,
			max_audits: 0,
			audit_increments: 0,
			section_code: String,
			title: String,
			pretty_title: String,
			override_course_description: String,
			current_status: String,
			location: String,
			room: String,
			is_audio: False,
			is_oncampus: False,
			distance_ed_materials: String,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			first_meeting_date: 0001-01-01,
			last_meeting_date: 0001-01-01,
			meeting_days: String,
			start_times: String,
			end_times: String,
			is_pass_fail: False,
			is_weekend: False,
			is_weekday: False,
			is_evening: False,
			is_waitlist: False,
			has_special_requirements: False,
			special_requirements: String,
			is_unlisted: False,
			capacity: 0,
			flat_fee_amount: 0,
			additional_fee_amount: 0,
			override_registration_start_date: 0001-01-01,
			override_registration_end_date: 0001-01-01,
			override_add_start_date: 0001-01-01,
			override_add_end_date: 0001-01-01,
			override_drop_start_date: 0001-01-01,
			override_drop_end_date: 0001-01-01,
			override_grading_end_date: 0001-01-01,
			term: String,
			reporting_term: String,
			reporting_year: 0,
			added_date: 0001-01-01,
			added_by: String,
			changed_date: 0001-01-01,
			changed_by: String,
			timestamp: 0001-01-01
		}
	],
	section_rates: 
	{
		0: 
		[
			{
				rate_id: 0,
				charge: 0,
				credit: 0,
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				uuid: String,
				secUUID: String,
				section_id: 0,
				course_name: String,
				section_code: String,
				title: String,
				reporting_term: String,
				rate_code: String,
				rate_description: String,
				is_override_credit_rate: False,
				is_override_audit_rate: False
			}
		]
	},
	section_refund_schedules: 
	{
		0: 
		[
			{
				responseStatus: 
				{
					errorCode: String,
					message: String,
					stackTrace: String,
					errors: 
					[
						{
							errorCode: String,
							fieldName: String,
							message: String,
							meta: 
							{
								String: String
							}
						}
					],
					meta: 
					{
						String: String
					}
				},
				uuid: String,
				secUUID: String,
				section_id: 0,
				course_name: String,
				section_code: String,
				title: String,
				reporting_term: String,
				rate_code: String,
				rate_description: String,
				percentage: 0,
				start_date: 0001-01-01,
				end_date: 0001-01-01
			}
		]
	},
	locations: 
	[
		String
	],
	section_instructors: 
	{
		0: 
		[
			{
				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
			}
		]
	},
	section_document_codes: 
	{
		0: 
		[
			String
		]
	},
	crosslisted_sections: 
	{
		0: 
		[
			0
		]
	}
}