regis

<back to all web services

RegistrationInProgressSummaryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}
POST/Registration/InProgressSummary/{uuid}/Term/{reporting_term}/{transaction_uuid}
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 RegistrationInProgressSummaryResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? transaction_uuid;
    int? regent_id;
    String? uuid;
    String? reporting_term;
    int? numberOfStudentSections;
    double? amountOwing;
    bool? mustPayBeforeRegistering;
    List<RegistrationDocumentResponse>? requiredDocuments;
    List<RegistrationDocumentResponse>? completedDocuments;
    bool? isLate;

    RegistrationInProgressSummaryResponse({this.responseStatus,this.transaction_uuid,this.regent_id,this.uuid,this.reporting_term,this.numberOfStudentSections,this.amountOwing,this.mustPayBeforeRegistering,this.requiredDocuments,this.completedDocuments,this.isLate});
    RegistrationInProgressSummaryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        transaction_uuid = json['transaction_uuid'];
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        reporting_term = json['reporting_term'];
        numberOfStudentSections = json['numberOfStudentSections'];
        amountOwing = JsonConverters.toDouble(json['amountOwing']);
        mustPayBeforeRegistering = json['mustPayBeforeRegistering'];
        requiredDocuments = JsonConverters.fromJson(json['requiredDocuments'],'List<RegistrationDocumentResponse>',context!);
        completedDocuments = JsonConverters.fromJson(json['completedDocuments'],'List<RegistrationDocumentResponse>',context!);
        isLate = json['isLate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'transaction_uuid': transaction_uuid,
        'regent_id': regent_id,
        'uuid': uuid,
        'reporting_term': reporting_term,
        'numberOfStudentSections': numberOfStudentSections,
        'amountOwing': amountOwing,
        'mustPayBeforeRegistering': mustPayBeforeRegistering,
        'requiredDocuments': JsonConverters.toJson(requiredDocuments,'List<RegistrationDocumentResponse>',context!),
        'completedDocuments': JsonConverters.toJson(completedDocuments,'List<RegistrationDocumentResponse>',context!),
        'isLate': isLate
    };

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

class RegistrationInProgressSummaryRequest implements IConvertible
{
    String? uuid;
    String? transaction_uuid;
    String? reporting_term;
    bool? online_only;

    RegistrationInProgressSummaryRequest({this.uuid,this.transaction_uuid,this.reporting_term,this.online_only});
    RegistrationInProgressSummaryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart RegistrationInProgressSummaryRequest 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 /Registration/InProgressSummary/{uuid}/Term/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","transaction_uuid":"String","reporting_term":"String","online_only":false}

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"}},"transaction_uuid":"String","regent_id":0,"uuid":"String","reporting_term":"String","numberOfStudentSections":0,"amountOwing":0,"mustPayBeforeRegistering":false,"requiredDocuments":[{"uuid":"String","regent_id":0,"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":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"completedDocuments":[{"uuid":"String","regent_id":0,"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":"String","added_date":"0001-01-01T00:00:00.0000000","changed_date":"0001-01-01T00:00:00.0000000"}],"isLate":false}