regis

<back to all web services

TermRequest

Requires Authentication
Required permission:ReadTerm
The following routes are available for this service:
POST/Terms/{term}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class TermResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    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;
    int? number_of_sections;
    int? number_of_rates;

    TermResponse({this.responseStatus,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.number_of_sections,this.number_of_rates});
    TermResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        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!);
        number_of_sections = json['number_of_sections'];
        number_of_rates = json['number_of_rates'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        '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!),
        'number_of_sections': number_of_sections,
        'number_of_rates': number_of_rates
    };

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

class TermRequest implements IConvertible
{
    String? term;

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

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

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

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

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

Dart TermRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Terms/{term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"term":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"term":"String","reporting_term":"String","reporting_year":0,"description":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","registration_start_date":"0001-01-01T00:00:00.0000000","registration_end_date":"0001-01-01T00:00:00.0000000","drop_start_date":"0001-01-01T00:00:00.0000000","drop_end_date":"0001-01-01T00:00:00.0000000","add_start_date":"0001-01-01T00:00:00.0000000","add_end_date":"0001-01-01T00:00:00.0000000","grading_end_date":"0001-01-01T00:00:00.0000000","number_of_sections":0,"number_of_rates":0}