regis

<back to all web services

TermCreateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Terms/Create
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class TermCreateRequest implements IConvertible
{
    String? authorizing_uuid;
    String? term;
    String? reporting_term;
    int? reporting_year;
    String? description;
    DateTime? start_date;
    DateTime? end_date;
    DateTime? registration_start_date;
    DateTime? registration_end_date;
    DateTime? drop_start_date;
    DateTime? drop_end_date;
    DateTime? add_start_date;
    DateTime? add_end_date;
    DateTime? grading_end_date;
    String? duplicate_rates_from_previous_reporting_term;

    TermCreateRequest({this.authorizing_uuid,this.term,this.reporting_term,this.reporting_year,this.description,this.start_date,this.end_date,this.registration_start_date,this.registration_end_date,this.drop_start_date,this.drop_end_date,this.add_start_date,this.add_end_date,this.grading_end_date,this.duplicate_rates_from_previous_reporting_term});
    TermCreateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        authorizing_uuid = json['authorizing_uuid'];
        term = json['term'];
        reporting_term = json['reporting_term'];
        reporting_year = json['reporting_year'];
        description = json['description'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        registration_start_date = JsonConverters.fromJson(json['registration_start_date'],'DateTime',context!);
        registration_end_date = JsonConverters.fromJson(json['registration_end_date'],'DateTime',context!);
        drop_start_date = JsonConverters.fromJson(json['drop_start_date'],'DateTime',context!);
        drop_end_date = JsonConverters.fromJson(json['drop_end_date'],'DateTime',context!);
        add_start_date = JsonConverters.fromJson(json['add_start_date'],'DateTime',context!);
        add_end_date = JsonConverters.fromJson(json['add_end_date'],'DateTime',context!);
        grading_end_date = JsonConverters.fromJson(json['grading_end_date'],'DateTime',context!);
        duplicate_rates_from_previous_reporting_term = json['duplicate_rates_from_previous_reporting_term'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'authorizing_uuid': authorizing_uuid,
        'term': term,
        'reporting_term': reporting_term,
        'reporting_year': reporting_year,
        'description': description,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
        'registration_start_date': JsonConverters.toJson(registration_start_date,'DateTime',context!),
        'registration_end_date': JsonConverters.toJson(registration_end_date,'DateTime',context!),
        'drop_start_date': JsonConverters.toJson(drop_start_date,'DateTime',context!),
        'drop_end_date': JsonConverters.toJson(drop_end_date,'DateTime',context!),
        'add_start_date': JsonConverters.toJson(add_start_date,'DateTime',context!),
        'add_end_date': JsonConverters.toJson(add_end_date,'DateTime',context!),
        'grading_end_date': JsonConverters.toJson(grading_end_date,'DateTime',context!),
        'duplicate_rates_from_previous_reporting_term': duplicate_rates_from_previous_reporting_term
    };

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'TermCreateRequest': TypeInfo(TypeOf.Class, create:() => TermCreateRequest()),
});

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

{
	authorizing_uuid: String,
	term: String,
	reporting_term: String,
	reporting_year: 0,
	description: String,
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	registration_start_date: 0001-01-01,
	registration_end_date: 0001-01-01,
	drop_start_date: 0001-01-01,
	drop_end_date: 0001-01-01,
	add_start_date: 0001-01-01,
	add_end_date: 0001-01-01,
	grading_end_date: 0001-01-01,
	duplicate_rates_from_previous_reporting_term: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}