Required role: | REGISUserRole |
POST | /Academic/{uuid}/Summary |
---|
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 AcademicSummaryResponse implements IConvertible
{
ResponseStatus? responseStatus;
int? regent_id;
String? uuid;
double? gpa;
List<StudentProgramSimpleResponse>? student_programs;
String? unofficial_undergraduate_degree_description;
List<String>? messages;
AcademicSummaryResponse({this.responseStatus,this.regent_id,this.uuid,this.gpa,this.student_programs,this.unofficial_undergraduate_degree_description,this.messages});
AcademicSummaryResponse.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'];
gpa = JsonConverters.toDouble(json['gpa']);
student_programs = JsonConverters.fromJson(json['student_programs'],'List<StudentProgramSimpleResponse>',context!);
unofficial_undergraduate_degree_description = json['unofficial_undergraduate_degree_description'];
messages = JsonConverters.fromJson(json['messages'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'regent_id': regent_id,
'uuid': uuid,
'gpa': gpa,
'student_programs': JsonConverters.toJson(student_programs,'List<StudentProgramSimpleResponse>',context!),
'unofficial_undergraduate_degree_description': unofficial_undergraduate_degree_description,
'messages': JsonConverters.toJson(messages,'List<String>',context!)
};
getTypeName() => "AcademicSummaryResponse";
TypeContext? context = _ctx;
}
class AcademicSummaryRequest implements IConvertible
{
String? uuid;
AcademicSummaryRequest({this.uuid});
AcademicSummaryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
uuid = json['uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'uuid': uuid
};
getTypeName() => "AcademicSummaryRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
'StudentProgramSimpleResponse': TypeInfo(TypeOf.Class, create:() => StudentProgramSimpleResponse()),
'AcademicSummaryResponse': TypeInfo(TypeOf.Class, create:() => AcademicSummaryResponse()),
'List<StudentProgramSimpleResponse>': TypeInfo(TypeOf.Class, create:() => <StudentProgramSimpleResponse>[]),
'AcademicSummaryRequest': TypeInfo(TypeOf.Class, create:() => AcademicSummaryRequest()),
});
Dart AcademicSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Academic/{uuid}/Summary HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AcademicSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</AcademicSummaryRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AcademicSummaryResponse 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> <gpa>0</gpa> <messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </messages> <regent_id>0</regent_id> <student_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> </student_programs> <unofficial_undergraduate_degree_description>String</unofficial_undergraduate_degree_description> <uuid>String</uuid> </AcademicSummaryResponse>