regis

<back to all web services

SectionRequest

Requires Authentication
Required permission:ReadSections
The following routes are available for this service:
POST/Section/{uuid}
import 'package:servicestack/servicestack.dart';

class InstructorResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? regent_login;
    String? preferred_name;
    String? first_name;
    String? last_name;
    String? full_name;
    String? email;
    String? image_base64;

    InstructorResponse({this.responseStatus,this.regent_id,this.regent_login,this.preferred_name,this.first_name,this.last_name,this.full_name,this.email,this.image_base64});
    InstructorResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        regent_login = json['regent_login'];
        preferred_name = json['preferred_name'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        full_name = json['full_name'];
        email = json['email'];
        image_base64 = json['image_base64'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'regent_login': regent_login,
        'preferred_name': preferred_name,
        'first_name': first_name,
        'last_name': last_name,
        'full_name': full_name,
        'email': email,
        'image_base64': image_base64
    };

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

class DocumentResponse implements IConvertible
{
    String? code;
    String? document_name;
    String? document_description;

    DocumentResponse({this.code,this.document_name,this.document_description});
    DocumentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'code': code,
        'document_name': document_name,
        'document_description': document_description
    };

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

class SectionResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? secUUID;
    String? course_name;
    String? section_code;
    String? course_title;
    String? course_short_title;
    String? course_description;
    String? crosslist_description;
    String? crosslist_course_name;
    String? location_long_name;
    String? room;
    List<InstructorResponse>? instructors;
    List<DocumentResponse>? required_documents;
    DateTime? start_date;
    DateTime? end_date;
    DateTime? first_meeting_date;
    DateTime? last_meeting_date;
    String? meeting_days;
    List<String>? start_times;
    List<String>? end_times;
    bool? is_online_only;
    bool? is_weekend;
    bool? is_weekday;
    bool? is_evening;
    bool? is_waitlist;
    bool? has_special_requirements;
    String? special_requirements;
    bool? is_unlisted;
    List<double>? credit_amounts;
    List<double>? audit_amounts;
    String? audits_short_name;
    String? audits_long_name;
    String? credits_short_name;
    String? credits_long_name;
    String? distance_ed_materials;
    String? prerequisites;
    String? corequisites;
    int? capacity;
    double? flat_fee_amount;
    double? additional_fee_amount;
    int? registered_students;
    int? three_credit_plus;
    int? two_credit;
    int? one_credit;
    int? three_audit_plus;
    int? two_audit;
    int? one_audit;
    int? crosslist_registered_students;
    int? grades_received;
    int? crosslist_grades_received;
    DateTime? registration_start_date;
    DateTime? registration_end_date;
    DateTime? add_start_date;
    DateTime? add_end_date;
    DateTime? drop_start_date;
    DateTime? drop_end_date;
    DateTime? grading_end_date;
    String? term;
    String? reporting_term;
    int? reporting_year;
    String? current_status;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;
    DateTime? timestamp;

    SectionResponse({this.responseStatus,this.secUUID,this.course_name,this.section_code,this.course_title,this.course_short_title,this.course_description,this.crosslist_description,this.crosslist_course_name,this.location_long_name,this.room,this.instructors,this.required_documents,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_online_only,this.is_weekend,this.is_weekday,this.is_evening,this.is_waitlist,this.has_special_requirements,this.special_requirements,this.is_unlisted,this.credit_amounts,this.audit_amounts,this.audits_short_name,this.audits_long_name,this.credits_short_name,this.credits_long_name,this.distance_ed_materials,this.prerequisites,this.corequisites,this.capacity,this.flat_fee_amount,this.additional_fee_amount,this.registered_students,this.three_credit_plus,this.two_credit,this.one_credit,this.three_audit_plus,this.two_audit,this.one_audit,this.crosslist_registered_students,this.grades_received,this.crosslist_grades_received,this.registration_start_date,this.registration_end_date,this.add_start_date,this.add_end_date,this.drop_start_date,this.drop_end_date,this.grading_end_date,this.term,this.reporting_term,this.reporting_year,this.current_status,this.added_by,this.added_date,this.changed_by,this.changed_date,this.timestamp});
    SectionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        secUUID = json['secUUID'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        course_title = json['course_title'];
        course_short_title = json['course_short_title'];
        course_description = json['course_description'];
        crosslist_description = json['crosslist_description'];
        crosslist_course_name = json['crosslist_course_name'];
        location_long_name = json['location_long_name'];
        room = json['room'];
        instructors = JsonConverters.fromJson(json['instructors'],'List<InstructorResponse>',context!);
        required_documents = JsonConverters.fromJson(json['required_documents'],'List<DocumentResponse>',context!);
        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 = JsonConverters.fromJson(json['start_times'],'List<String>',context!);
        end_times = JsonConverters.fromJson(json['end_times'],'List<String>',context!);
        is_online_only = json['is_online_only'];
        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'];
        credit_amounts = JsonConverters.fromJson(json['credit_amounts'],'List<double>',context!);
        audit_amounts = JsonConverters.fromJson(json['audit_amounts'],'List<double>',context!);
        audits_short_name = json['audits_short_name'];
        audits_long_name = json['audits_long_name'];
        credits_short_name = json['credits_short_name'];
        credits_long_name = json['credits_long_name'];
        distance_ed_materials = json['distance_ed_materials'];
        prerequisites = json['prerequisites'];
        corequisites = json['corequisites'];
        capacity = json['capacity'];
        flat_fee_amount = JsonConverters.toDouble(json['flat_fee_amount']);
        additional_fee_amount = JsonConverters.toDouble(json['additional_fee_amount']);
        registered_students = json['registered_students'];
        three_credit_plus = json['three_credit_plus'];
        two_credit = json['two_credit'];
        one_credit = json['one_credit'];
        three_audit_plus = json['three_audit_plus'];
        two_audit = json['two_audit'];
        one_audit = json['one_audit'];
        crosslist_registered_students = json['crosslist_registered_students'];
        grades_received = json['grades_received'];
        crosslist_grades_received = json['crosslist_grades_received'];
        registration_start_date = JsonConverters.fromJson(json['registration_start_date'],'DateTime',context!);
        registration_end_date = JsonConverters.fromJson(json['registration_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!);
        drop_start_date = JsonConverters.fromJson(json['drop_start_date'],'DateTime',context!);
        drop_end_date = JsonConverters.fromJson(json['drop_end_date'],'DateTime',context!);
        grading_end_date = JsonConverters.fromJson(json['grading_end_date'],'DateTime',context!);
        term = json['term'];
        reporting_term = json['reporting_term'];
        reporting_year = json['reporting_year'];
        current_status = json['current_status'];
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        timestamp = JsonConverters.fromJson(json['timestamp'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'secUUID': secUUID,
        'course_name': course_name,
        'section_code': section_code,
        'course_title': course_title,
        'course_short_title': course_short_title,
        'course_description': course_description,
        'crosslist_description': crosslist_description,
        'crosslist_course_name': crosslist_course_name,
        'location_long_name': location_long_name,
        'room': room,
        'instructors': JsonConverters.toJson(instructors,'List<InstructorResponse>',context!),
        'required_documents': JsonConverters.toJson(required_documents,'List<DocumentResponse>',context!),
        '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': JsonConverters.toJson(start_times,'List<String>',context!),
        'end_times': JsonConverters.toJson(end_times,'List<String>',context!),
        'is_online_only': is_online_only,
        '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,
        'credit_amounts': JsonConverters.toJson(credit_amounts,'List<double>',context!),
        'audit_amounts': JsonConverters.toJson(audit_amounts,'List<double>',context!),
        'audits_short_name': audits_short_name,
        'audits_long_name': audits_long_name,
        'credits_short_name': credits_short_name,
        'credits_long_name': credits_long_name,
        'distance_ed_materials': distance_ed_materials,
        'prerequisites': prerequisites,
        'corequisites': corequisites,
        'capacity': capacity,
        'flat_fee_amount': flat_fee_amount,
        'additional_fee_amount': additional_fee_amount,
        'registered_students': registered_students,
        'three_credit_plus': three_credit_plus,
        'two_credit': two_credit,
        'one_credit': one_credit,
        'three_audit_plus': three_audit_plus,
        'two_audit': two_audit,
        'one_audit': one_audit,
        'crosslist_registered_students': crosslist_registered_students,
        'grades_received': grades_received,
        'crosslist_grades_received': crosslist_grades_received,
        'registration_start_date': JsonConverters.toJson(registration_start_date,'DateTime',context!),
        'registration_end_date': JsonConverters.toJson(registration_end_date,'DateTime',context!),
        'add_start_date': JsonConverters.toJson(add_start_date,'DateTime',context!),
        'add_end_date': JsonConverters.toJson(add_end_date,'DateTime',context!),
        'drop_start_date': JsonConverters.toJson(drop_start_date,'DateTime',context!),
        'drop_end_date': JsonConverters.toJson(drop_end_date,'DateTime',context!),
        'grading_end_date': JsonConverters.toJson(grading_end_date,'DateTime',context!),
        'term': term,
        'reporting_term': reporting_term,
        'reporting_year': reporting_year,
        'current_status': current_status,
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_by': changed_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
        'timestamp': JsonConverters.toJson(timestamp,'DateTime',context!)
    };

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

class SectionRequest implements IConvertible
{
    String? uuid;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'InstructorResponse': TypeInfo(TypeOf.Class, create:() => InstructorResponse()),
    'DocumentResponse': TypeInfo(TypeOf.Class, create:() => DocumentResponse()),
    'SectionResponse': TypeInfo(TypeOf.Class, create:() => SectionResponse()),
    'List<InstructorResponse>': TypeInfo(TypeOf.Class, create:() => <InstructorResponse>[]),
    'List<DocumentResponse>': TypeInfo(TypeOf.Class, create:() => <DocumentResponse>[]),
    'SectionRequest': TypeInfo(TypeOf.Class, create:() => SectionRequest()),
});

Dart SectionRequest 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 /Section/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<SectionResponse 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>
  <added_by>String</added_by>
  <added_date>0001-01-01T00:00:00</added_date>
  <additional_fee_amount>0</additional_fee_amount>
  <audit_amounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </audit_amounts>
  <audits_long_name>String</audits_long_name>
  <audits_short_name>String</audits_short_name>
  <capacity>0</capacity>
  <changed_by>String</changed_by>
  <changed_date>0001-01-01T00:00:00</changed_date>
  <corequisites>String</corequisites>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <course_short_title>String</course_short_title>
  <course_title>String</course_title>
  <credit_amounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>0</d2p1:decimal>
  </credit_amounts>
  <credits_long_name>String</credits_long_name>
  <credits_short_name>String</credits_short_name>
  <crosslist_course_name>String</crosslist_course_name>
  <crosslist_description>String</crosslist_description>
  <crosslist_grades_received>0</crosslist_grades_received>
  <crosslist_registered_students>0</crosslist_registered_students>
  <current_status>String</current_status>
  <distance_ed_materials>String</distance_ed_materials>
  <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>
  <end_times xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </end_times>
  <first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
  <flat_fee_amount>0</flat_fee_amount>
  <grades_received>0</grades_received>
  <grading_end_date>0001-01-01T00:00:00</grading_end_date>
  <has_special_requirements>false</has_special_requirements>
  <instructors>
    <InstructorResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <email>String</email>
      <first_name>String</first_name>
      <full_name>String</full_name>
      <image_base64>String</image_base64>
      <last_name>String</last_name>
      <preferred_name>String</preferred_name>
      <regent_id>0</regent_id>
      <regent_login>String</regent_login>
    </InstructorResponse>
  </instructors>
  <is_evening>false</is_evening>
  <is_online_only>false</is_online_only>
  <is_unlisted>false</is_unlisted>
  <is_waitlist>false</is_waitlist>
  <is_weekday>false</is_weekday>
  <is_weekend>false</is_weekend>
  <last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
  <location_long_name>String</location_long_name>
  <meeting_days>String</meeting_days>
  <one_audit>0</one_audit>
  <one_credit>0</one_credit>
  <prerequisites>String</prerequisites>
  <registered_students>0</registered_students>
  <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>
  <required_documents>
    <DocumentResponse>
      <code>String</code>
      <document_description>String</document_description>
      <document_name>String</document_name>
    </DocumentResponse>
  </required_documents>
  <room>String</room>
  <secUUID>String</secUUID>
  <section_code>String</section_code>
  <special_requirements>String</special_requirements>
  <start_date>0001-01-01T00:00:00</start_date>
  <start_times xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </start_times>
  <term>String</term>
  <three_audit_plus>0</three_audit_plus>
  <three_credit_plus>0</three_credit_plus>
  <timestamp>0001-01-01T00:00:00</timestamp>
  <two_audit>0</two_audit>
  <two_credit>0</two_credit>
</SectionResponse>