regis

StudentProgramsRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/StudentPrograms

import 'package:servicestack/servicestack.dart';

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

<StudentProgramsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</StudentProgramsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StudentProgramsResponse 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>
  <programs>
    <StudentProgramSimpleResponse>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1: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>
        </d4p1:Meta>
      </ResponseStatus>
      <catalog>String</catalog>
      <concentration_code>String</concentration_code>
      <concentration_name>String</concentration_name>
      <end_date>0001-01-01T00:00:00</end_date>
      <is_active>false</is_active>
      <is_graduated>false</is_graduated>
      <program_code>String</program_code>
      <program_id>0</program_id>
      <program_name>String</program_name>
      <regent_id>0</regent_id>
      <start_date>0001-01-01T00:00:00</start_date>
      <uuid>String</uuid>
    </StudentProgramSimpleResponse>
  </programs>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</StudentProgramsResponse>