regis

<back to all web services

StudentProgramsRequest

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

class StudentProgramSimpleResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    int? program_id;
    String? program_code;
    String? program_name;
    String? concentration_code;
    String? concentration_name;
    DateTime? start_date;
    DateTime? end_date;
    String? catalog;
    bool? is_active;
    bool? is_graduated;

    StudentProgramSimpleResponse({this.responseStatus,this.regent_id,this.uuid,this.program_id,this.program_code,this.program_name,this.concentration_code,this.concentration_name,this.start_date,this.end_date,this.catalog,this.is_active,this.is_graduated});
    StudentProgramSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        program_id = json['program_id'];
        program_code = json['program_code'];
        program_name = json['program_name'];
        concentration_code = json['concentration_code'];
        concentration_name = json['concentration_name'];
        start_date = JsonConverters.fromJson(json['start_date'],'DateTime',context!);
        end_date = JsonConverters.fromJson(json['end_date'],'DateTime',context!);
        catalog = json['catalog'];
        is_active = json['is_active'];
        is_graduated = json['is_graduated'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'program_id': program_id,
        'program_code': program_code,
        'program_name': program_name,
        'concentration_code': concentration_code,
        'concentration_name': concentration_name,
        'start_date': JsonConverters.toJson(start_date,'DateTime',context!),
        'end_date': JsonConverters.toJson(end_date,'DateTime',context!),
        'catalog': catalog,
        'is_active': is_active,
        'is_graduated': is_graduated
    };

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

class StudentProgramsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? regent_id;
    String? uuid;
    List<StudentProgramSimpleResponse>? programs;

    StudentProgramsResponse({this.responseStatus,this.regent_id,this.uuid,this.programs});
    StudentProgramsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'programs': JsonConverters.toJson(programs,'List<StudentProgramSimpleResponse>',context!)
    };

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

class StudentProgramsRequest implements IConvertible
{
    String? uuid;

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

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

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

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

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

Dart StudentProgramsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /StudentPrograms HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"regent_id":0,"uuid":"String","program_id":0,"program_code":"String","program_name":"String","concentration_code":"String","concentration_name":"String","start_date":"0001-01-01T00:00:00.0000000","end_date":"0001-01-01T00:00:00.0000000","catalog":"String","is_active":false,"is_graduated":false}]}