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';

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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<TermRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <term>String</term>
</TermRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TermResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <add_end_date>0001-01-01T00:00:00</add_end_date>
  <add_start_date>0001-01-01T00:00:00</add_start_date>
  <description>String</description>
  <drop_end_date>0001-01-01T00:00:00</drop_end_date>
  <drop_start_date>0001-01-01T00:00:00</drop_start_date>
  <end_date>0001-01-01T00:00:00</end_date>
  <grading_end_date>0001-01-01T00:00:00</grading_end_date>
  <number_of_rates>0</number_of_rates>
  <number_of_sections>0</number_of_sections>
  <registration_end_date>0001-01-01T00:00:00</registration_end_date>
  <registration_start_date>0001-01-01T00:00:00</registration_start_date>
  <reporting_term>String</reporting_term>
  <reporting_year>0</reporting_year>
  <start_date>0001-01-01T00:00:00</start_date>
  <term>String</term>
</TermResponse>