| Required permission: | ReadExternalDegrees |
| POST | /Academic/{uuid}/ExternalDegrees |
|---|
import 'package:servicestack/servicestack.dart';
class PersonSimpleResponse implements IConvertible
{
ResponseStatus? responseStatus;
int? regent_id;
int? ubc_id;
String? uuid;
String? regent_login;
String? first_name;
String? preferred_name;
String? middle_name;
String? last_name;
String? email;
String? phone_home;
String? phone_cell;
String? phone_bus;
String? addr1;
String? addr2;
String? city;
String? state;
String? country;
String? code;
String? citizenship;
String? citizenship_other;
String? permanent_resident;
DateTime? dob;
bool? is_student;
bool? is_faculty;
bool? is_vendor;
PersonSimpleResponse({this.responseStatus,this.regent_id,this.ubc_id,this.uuid,this.regent_login,this.first_name,this.preferred_name,this.middle_name,this.last_name,this.email,this.phone_home,this.phone_cell,this.phone_bus,this.addr1,this.addr2,this.city,this.state,this.country,this.code,this.citizenship,this.citizenship_other,this.permanent_resident,this.dob,this.is_student,this.is_faculty,this.is_vendor});
PersonSimpleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
regent_id = json['regent_id'];
ubc_id = json['ubc_id'];
uuid = json['uuid'];
regent_login = json['regent_login'];
first_name = json['first_name'];
preferred_name = json['preferred_name'];
middle_name = json['middle_name'];
last_name = json['last_name'];
email = json['email'];
phone_home = json['phone_home'];
phone_cell = json['phone_cell'];
phone_bus = json['phone_bus'];
addr1 = json['addr1'];
addr2 = json['addr2'];
city = json['city'];
state = json['state'];
country = json['country'];
code = json['code'];
citizenship = json['citizenship'];
citizenship_other = json['citizenship_other'];
permanent_resident = json['permanent_resident'];
dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
is_student = json['is_student'];
is_faculty = json['is_faculty'];
is_vendor = json['is_vendor'];
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'regent_id': regent_id,
'ubc_id': ubc_id,
'uuid': uuid,
'regent_login': regent_login,
'first_name': first_name,
'preferred_name': preferred_name,
'middle_name': middle_name,
'last_name': last_name,
'email': email,
'phone_home': phone_home,
'phone_cell': phone_cell,
'phone_bus': phone_bus,
'addr1': addr1,
'addr2': addr2,
'city': city,
'state': state,
'country': country,
'code': code,
'citizenship': citizenship,
'citizenship_other': citizenship_other,
'permanent_resident': permanent_resident,
'dob': JsonConverters.toJson(dob,'DateTime',context!),
'is_student': is_student,
'is_faculty': is_faculty,
'is_vendor': is_vendor
};
getTypeName() => "PersonSimpleResponse";
TypeContext? context = _ctx;
}
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 ExternalDegreeResponse implements IConvertible
{
int? id;
int? institution_id;
String? degree_name;
String? degree_override_name;
String? institution_name;
String? graduation_month;
int? start_year;
int? end_year;
bool? is_only_in_d365;
ExternalDegreeResponse({this.id,this.institution_id,this.degree_name,this.degree_override_name,this.institution_name,this.graduation_month,this.start_year,this.end_year,this.is_only_in_d365});
ExternalDegreeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
institution_id = json['institution_id'];
degree_name = json['degree_name'];
degree_override_name = json['degree_override_name'];
institution_name = json['institution_name'];
graduation_month = json['graduation_month'];
start_year = json['start_year'];
end_year = json['end_year'];
is_only_in_d365 = json['is_only_in_d365'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'institution_id': institution_id,
'degree_name': degree_name,
'degree_override_name': degree_override_name,
'institution_name': institution_name,
'graduation_month': graduation_month,
'start_year': start_year,
'end_year': end_year,
'is_only_in_d365': is_only_in_d365
};
getTypeName() => "ExternalDegreeResponse";
TypeContext? context = _ctx;
}
class ExternalDegreesAdminResponse implements IConvertible
{
String? degree_code;
String? degree_name;
String? degree_type;
ExternalDegreesAdminResponse({this.degree_code,this.degree_name,this.degree_type});
ExternalDegreesAdminResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
degree_code = json['degree_code'];
degree_name = json['degree_name'];
degree_type = json['degree_type'];
return this;
}
Map<String, dynamic> toJson() => {
'degree_code': degree_code,
'degree_name': degree_name,
'degree_type': degree_type
};
getTypeName() => "ExternalDegreesAdminResponse";
TypeContext? context = _ctx;
}
class ExternalDegreesResponse implements IConvertible
{
ResponseStatus? responseStatus;
PersonSimpleResponse? person;
double? gpa;
List<StudentProgramSimpleResponse>? student_programs;
List<ExternalDegreeResponse>? degrees;
List<ExternalDegreesAdminResponse>? valid_degrees;
ExternalDegreesResponse({this.responseStatus,this.person,this.gpa,this.student_programs,this.degrees,this.valid_degrees});
ExternalDegreesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
person = JsonConverters.fromJson(json['person'],'PersonSimpleResponse',context!);
gpa = JsonConverters.toDouble(json['gpa']);
student_programs = JsonConverters.fromJson(json['student_programs'],'List<StudentProgramSimpleResponse>',context!);
degrees = JsonConverters.fromJson(json['degrees'],'List<ExternalDegreeResponse>',context!);
valid_degrees = JsonConverters.fromJson(json['valid_degrees'],'List<ExternalDegreesAdminResponse>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'person': JsonConverters.toJson(person,'PersonSimpleResponse',context!),
'gpa': gpa,
'student_programs': JsonConverters.toJson(student_programs,'List<StudentProgramSimpleResponse>',context!),
'degrees': JsonConverters.toJson(degrees,'List<ExternalDegreeResponse>',context!),
'valid_degrees': JsonConverters.toJson(valid_degrees,'List<ExternalDegreesAdminResponse>',context!)
};
getTypeName() => "ExternalDegreesResponse";
TypeContext? context = _ctx;
}
class ExternalDegreesRequest implements IConvertible
{
String? uuid;
ExternalDegreesRequest({this.uuid});
ExternalDegreesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
uuid = json['uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'uuid': uuid
};
getTypeName() => "ExternalDegreesRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
'PersonSimpleResponse': TypeInfo(TypeOf.Class, create:() => PersonSimpleResponse()),
'StudentProgramSimpleResponse': TypeInfo(TypeOf.Class, create:() => StudentProgramSimpleResponse()),
'ExternalDegreeResponse': TypeInfo(TypeOf.Class, create:() => ExternalDegreeResponse()),
'ExternalDegreesAdminResponse': TypeInfo(TypeOf.Class, create:() => ExternalDegreesAdminResponse()),
'ExternalDegreesResponse': TypeInfo(TypeOf.Class, create:() => ExternalDegreesResponse()),
'List<StudentProgramSimpleResponse>': TypeInfo(TypeOf.Class, create:() => <StudentProgramSimpleResponse>[]),
'List<ExternalDegreeResponse>': TypeInfo(TypeOf.Class, create:() => <ExternalDegreeResponse>[]),
'List<ExternalDegreesAdminResponse>': TypeInfo(TypeOf.Class, create:() => <ExternalDegreesAdminResponse>[]),
'ExternalDegreesRequest': TypeInfo(TypeOf.Class, create:() => ExternalDegreesRequest()),
});
Dart ExternalDegreesRequest 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}/ExternalDegrees HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ExternalDegreesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</ExternalDegreesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ExternalDegreesResponse 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>
<degrees>
<ExternalDegreeResponse>
<degree_name>String</degree_name>
<degree_override_name>String</degree_override_name>
<end_year>0</end_year>
<graduation_month>String</graduation_month>
<id>0</id>
<institution_id>0</institution_id>
<institution_name>String</institution_name>
<is_only_in_d365>false</is_only_in_d365>
<start_year>0</start_year>
</ExternalDegreeResponse>
</degrees>
<gpa>0</gpa>
<person>
<ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:Message>String</d3p1:Message>
<d3p1:StackTrace>String</d3p1:StackTrace>
<d3p1:Errors>
<d3p1:ResponseError>
<d3p1:ErrorCode>String</d3p1:ErrorCode>
<d3p1:FieldName>String</d3p1:FieldName>
<d3p1:Message>String</d3p1:Message>
<d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:KeyValueOfstringstring>
<d6p1:Key>String</d6p1:Key>
<d6p1:Value>String</d6p1:Value>
</d6p1:KeyValueOfstringstring>
</d3p1:Meta>
</d3p1:ResponseError>
</d3p1:Errors>
<d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringstring>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>String</d4p1:Value>
</d4p1:KeyValueOfstringstring>
</d3p1:Meta>
</ResponseStatus>
<addr1>String</addr1>
<addr2>String</addr2>
<citizenship>String</citizenship>
<citizenship_other>String</citizenship_other>
<city>String</city>
<code>String</code>
<country>String</country>
<dob>0001-01-01T00:00:00</dob>
<email>String</email>
<first_name>String</first_name>
<is_faculty>false</is_faculty>
<is_student>false</is_student>
<is_vendor>false</is_vendor>
<last_name>String</last_name>
<middle_name>String</middle_name>
<permanent_resident>String</permanent_resident>
<phone_bus>String</phone_bus>
<phone_cell>String</phone_cell>
<phone_home>String</phone_home>
<preferred_name>String</preferred_name>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
<state>String</state>
<ubc_id>0</ubc_id>
<uuid>String</uuid>
</person>
<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>
<valid_degrees>
<ExternalDegreesAdminResponse>
<degree_code>String</degree_code>
<degree_name>String</degree_name>
<degree_type>String</degree_type>
</ExternalDegreesAdminResponse>
</valid_degrees>
</ExternalDegreesResponse>