regis

<back to all web services

ProgramsRequest

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

class ProgramResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    int? id;
    String? program_code;
    String? program_pretty_code;
    String? program_long_name;
    String? available_concentrations;
    bool? is_active;
    DateTime? timestamp;

    ProgramResponse({this.responseStatus,this.id,this.program_code,this.program_pretty_code,this.program_long_name,this.available_concentrations,this.is_active,this.timestamp});
    ProgramResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        id = json['id'];
        program_code = json['program_code'];
        program_pretty_code = json['program_pretty_code'];
        program_long_name = json['program_long_name'];
        available_concentrations = json['available_concentrations'];
        is_active = json['is_active'];
        timestamp = JsonConverters.fromJson(json['timestamp'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'id': id,
        'program_code': program_code,
        'program_pretty_code': program_pretty_code,
        'program_long_name': program_long_name,
        'available_concentrations': available_concentrations,
        'is_active': is_active,
        'timestamp': JsonConverters.toJson(timestamp,'DateTime',context!)
    };

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

class ProgramsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<ProgramResponse>? programs;

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

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

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

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

class ProgramsRequest implements IConvertible
{
    ProgramsRequest();
    ProgramsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "ProgramsRequest";
    TypeContext? context = _ctx;
}

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

Dart ProgramsRequest 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 /Programs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{}
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"}},"programs":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"id":0,"program_code":"String","program_pretty_code":"String","program_long_name":"String","available_concentrations":"String","is_active":false,"timestamp":"0001-01-01T00:00:00.0000000"}]}