regis

<back to all web services

CourseCreateRequest

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

class CourseRequirementResponse implements IConvertible
{
    int? course_id;
    int? required_course_id;
    int? requirement_group;
    bool? is_prerequisite;
    bool? is_corequisite;
    DateTime? timestamp;

    CourseRequirementResponse({this.course_id,this.required_course_id,this.requirement_group,this.is_prerequisite,this.is_corequisite,this.timestamp});
    CourseRequirementResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        course_id = json['course_id'];
        required_course_id = json['required_course_id'];
        requirement_group = json['requirement_group'];
        is_prerequisite = json['is_prerequisite'];
        is_corequisite = json['is_corequisite'];
        timestamp = JsonConverters.fromJson(json['timestamp'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'course_id': course_id,
        'required_course_id': required_course_id,
        'requirement_group': requirement_group,
        'is_prerequisite': is_prerequisite,
        'is_corequisite': is_corequisite,
        'timestamp': JsonConverters.toJson(timestamp,'DateTime',context!)
    };

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

class CourseCreateRequest implements IConvertible
{
    String? course_name;
    String? title;
    String? pretty_title;
    String? course_description;
    bool? is_active;
    List<CourseRequirementResponse>? course_requirements;
    String? authorizing_uuid;

    CourseCreateRequest({this.course_name,this.title,this.pretty_title,this.course_description,this.is_active,this.course_requirements,this.authorizing_uuid});
    CourseCreateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        course_name = json['course_name'];
        title = json['title'];
        pretty_title = json['pretty_title'];
        course_description = json['course_description'];
        is_active = json['is_active'];
        course_requirements = JsonConverters.fromJson(json['course_requirements'],'List<CourseRequirementResponse>',context!);
        authorizing_uuid = json['authorizing_uuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'course_name': course_name,
        'title': title,
        'pretty_title': pretty_title,
        'course_description': course_description,
        'is_active': is_active,
        'course_requirements': JsonConverters.toJson(course_requirements,'List<CourseRequirementResponse>',context!),
        'authorizing_uuid': authorizing_uuid
    };

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

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

Dart CourseCreateRequest 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 /Courses/Admin/Create HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourseCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <course_description>String</course_description>
  <course_name>String</course_name>
  <course_requirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
    <d2p1:CourseRequirementResponse>
      <d2p1:course_id>0</d2p1:course_id>
      <d2p1:is_corequisite>false</d2p1:is_corequisite>
      <d2p1:is_prerequisite>false</d2p1:is_prerequisite>
      <d2p1:required_course_id>0</d2p1:required_course_id>
      <d2p1:requirement_group>0</d2p1:requirement_group>
      <d2p1:timestamp>0001-01-01T00:00:00</d2p1:timestamp>
    </d2p1:CourseRequirementResponse>
  </course_requirements>
  <is_active>false</is_active>
  <pretty_title>String</pretty_title>
  <title>String</title>
</CourseCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>