regis

<back to all web services

ProvisionalRegistrationsRequest

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

class RegistrationDocumentResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    String? first_name;
    String? last_name;
    String? gender;
    String? email;
    String? program;
    String? concentration;
    String? section_uuid;
    String? course_name;
    String? course_title;
    String? reporting_term;
    String? document_code;
    String? document_json;
    String? document_name;
    String? document_description;
    DateTime? added_date;
    DateTime? changed_date;

    RegistrationDocumentResponse({this.uuid,this.regent_id,this.first_name,this.last_name,this.gender,this.email,this.program,this.concentration,this.section_uuid,this.course_name,this.course_title,this.reporting_term,this.document_code,this.document_json,this.document_name,this.document_description,this.added_date,this.changed_date});
    RegistrationDocumentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        gender = json['gender'];
        email = json['email'];
        program = json['program'];
        concentration = json['concentration'];
        section_uuid = json['section_uuid'];
        course_name = json['course_name'];
        course_title = json['course_title'];
        reporting_term = json['reporting_term'];
        document_code = json['document_code'];
        document_json = json['document_json'];
        document_name = json['document_name'];
        document_description = json['document_description'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'first_name': first_name,
        'last_name': last_name,
        'gender': gender,
        'email': email,
        'program': program,
        'concentration': concentration,
        'section_uuid': section_uuid,
        'course_name': course_name,
        'course_title': course_title,
        'reporting_term': reporting_term,
        'document_code': document_code,
        'document_json': document_json,
        'document_name': document_name,
        'document_description': document_description,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!)
    };

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

class ProvisionalRegistrationResponse implements IConvertible
{
    String? uuid;
    int? regent_id;
    String? student_name;
    String? email;
    String? section_uuid;
    String? student_section_uuid;
    String? course_name;
    String? section_code;
    String? title;
    String? term;
    double? amount;
    bool? is_audit;
    bool? is_waitlist;
    bool? is_missing_requisites;
    bool? is_other_restriction;
    List<RegistrationDocumentResponse>? documents;
    DateTime? requested_date;

    ProvisionalRegistrationResponse({this.uuid,this.regent_id,this.student_name,this.email,this.section_uuid,this.student_section_uuid,this.course_name,this.section_code,this.title,this.term,this.amount,this.is_audit,this.is_waitlist,this.is_missing_requisites,this.is_other_restriction,this.documents,this.requested_date});
    ProvisionalRegistrationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        uuid = json['uuid'];
        regent_id = json['regent_id'];
        student_name = json['student_name'];
        email = json['email'];
        section_uuid = json['section_uuid'];
        student_section_uuid = json['student_section_uuid'];
        course_name = json['course_name'];
        section_code = json['section_code'];
        title = json['title'];
        term = json['term'];
        amount = JsonConverters.toDouble(json['amount']);
        is_audit = json['is_audit'];
        is_waitlist = json['is_waitlist'];
        is_missing_requisites = json['is_missing_requisites'];
        is_other_restriction = json['is_other_restriction'];
        documents = JsonConverters.fromJson(json['documents'],'List<RegistrationDocumentResponse>',context!);
        requested_date = JsonConverters.fromJson(json['requested_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'uuid': uuid,
        'regent_id': regent_id,
        'student_name': student_name,
        'email': email,
        'section_uuid': section_uuid,
        'student_section_uuid': student_section_uuid,
        'course_name': course_name,
        'section_code': section_code,
        'title': title,
        'term': term,
        'amount': amount,
        'is_audit': is_audit,
        'is_waitlist': is_waitlist,
        'is_missing_requisites': is_missing_requisites,
        'is_other_restriction': is_other_restriction,
        'documents': JsonConverters.toJson(documents,'List<RegistrationDocumentResponse>',context!),
        'requested_date': JsonConverters.toJson(requested_date,'DateTime',context!)
    };

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

class ProvisionalRegistrationsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<ProvisionalRegistrationResponse>? provisional_registrations;

    ProvisionalRegistrationsResponse({this.responseStatus,this.provisional_registrations});
    ProvisionalRegistrationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        provisional_registrations = JsonConverters.fromJson(json['provisional_registrations'],'List<ProvisionalRegistrationResponse>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'provisional_registrations': JsonConverters.toJson(provisional_registrations,'List<ProvisionalRegistrationResponse>',context!)
    };

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

class ProvisionalRegistrationsRequest implements IConvertible
{
    String? reporting_term;
    String? authorizing_uuid;

    ProvisionalRegistrationsRequest({this.reporting_term,this.authorizing_uuid});
    ProvisionalRegistrationsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart ProvisionalRegistrationsRequest 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 /Registration/Provisional HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ProvisionalRegistrationsResponse 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>
  <provisional_registrations>
    <ProvisionalRegistrationResponse>
      <amount>0</amount>
      <course_name>String</course_name>
      <documents>
        <RegistrationDocumentResponse>
          <added_date>0001-01-01T00:00:00</added_date>
          <changed_date>0001-01-01T00:00:00</changed_date>
          <concentration>String</concentration>
          <course_name>String</course_name>
          <course_title>String</course_title>
          <document_code>String</document_code>
          <document_description>String</document_description>
          <document_json>String</document_json>
          <document_name>String</document_name>
          <email>String</email>
          <first_name>String</first_name>
          <gender>String</gender>
          <last_name>String</last_name>
          <program>String</program>
          <regent_id>0</regent_id>
          <reporting_term>String</reporting_term>
          <section_uuid>String</section_uuid>
          <uuid>String</uuid>
        </RegistrationDocumentResponse>
      </documents>
      <email>String</email>
      <is_audit>false</is_audit>
      <is_missing_requisites>false</is_missing_requisites>
      <is_other_restriction>false</is_other_restriction>
      <is_waitlist>false</is_waitlist>
      <regent_id>0</regent_id>
      <requested_date>0001-01-01T00:00:00</requested_date>
      <section_code>String</section_code>
      <section_uuid>String</section_uuid>
      <student_name>String</student_name>
      <student_section_uuid>String</student_section_uuid>
      <term>String</term>
      <title>String</title>
      <uuid>String</uuid>
    </ProvisionalRegistrationResponse>
  </provisional_registrations>
</ProvisionalRegistrationsResponse>