| Required role: | REGISUserRole |
| POST | /person/{uuid}/sidebar |
|---|
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 PersonSideBarResponse implements IConvertible
{
ResponseStatus? responseStatus;
int? regent_id;
int? ubc_id;
String? regent_login;
String? uuid;
String? first_name;
String? middle_name;
String? last_name;
String? preferred_name;
DateTime? dob;
String? citizenship;
String? citizenship_other;
String? permanent_resident;
String? addr1;
String? addr2;
String? city;
String? state;
String? code;
String? country;
String? email;
String? phone_home;
String? phone_cell;
String? phone_bus;
String? imageBase64;
String? tax_number;
List<StudentProgramSimpleResponse>? programs;
PersonSideBarResponse({this.responseStatus,this.regent_id,this.ubc_id,this.regent_login,this.uuid,this.first_name,this.middle_name,this.last_name,this.preferred_name,this.dob,this.citizenship,this.citizenship_other,this.permanent_resident,this.addr1,this.addr2,this.city,this.state,this.code,this.country,this.email,this.phone_home,this.phone_cell,this.phone_bus,this.imageBase64,this.tax_number,this.programs});
PersonSideBarResponse.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'];
regent_login = json['regent_login'];
uuid = json['uuid'];
first_name = json['first_name'];
middle_name = json['middle_name'];
last_name = json['last_name'];
preferred_name = json['preferred_name'];
dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
citizenship = json['citizenship'];
citizenship_other = json['citizenship_other'];
permanent_resident = json['permanent_resident'];
addr1 = json['addr1'];
addr2 = json['addr2'];
city = json['city'];
state = json['state'];
code = json['code'];
country = json['country'];
email = json['email'];
phone_home = json['phone_home'];
phone_cell = json['phone_cell'];
phone_bus = json['phone_bus'];
imageBase64 = json['imageBase64'];
tax_number = json['tax_number'];
programs = JsonConverters.fromJson(json['programs'],'List<StudentProgramSimpleResponse>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'regent_id': regent_id,
'ubc_id': ubc_id,
'regent_login': regent_login,
'uuid': uuid,
'first_name': first_name,
'middle_name': middle_name,
'last_name': last_name,
'preferred_name': preferred_name,
'dob': JsonConverters.toJson(dob,'DateTime',context!),
'citizenship': citizenship,
'citizenship_other': citizenship_other,
'permanent_resident': permanent_resident,
'addr1': addr1,
'addr2': addr2,
'city': city,
'state': state,
'code': code,
'country': country,
'email': email,
'phone_home': phone_home,
'phone_cell': phone_cell,
'phone_bus': phone_bus,
'imageBase64': imageBase64,
'tax_number': tax_number,
'programs': JsonConverters.toJson(programs,'List<StudentProgramSimpleResponse>',context!)
};
getTypeName() => "PersonSideBarResponse";
TypeContext? context = _ctx;
}
class PersonSideBarRequest implements IConvertible
{
String? uuid;
PersonSideBarRequest({this.uuid});
PersonSideBarRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
uuid = json['uuid'];
return this;
}
Map<String, dynamic> toJson() => {
'uuid': uuid
};
getTypeName() => "PersonSideBarRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
'StudentProgramSimpleResponse': TypeInfo(TypeOf.Class, create:() => StudentProgramSimpleResponse()),
'PersonSideBarResponse': TypeInfo(TypeOf.Class, create:() => PersonSideBarResponse()),
'List<StudentProgramSimpleResponse>': TypeInfo(TypeOf.Class, create:() => <StudentProgramSimpleResponse>[]),
'PersonSideBarRequest': TypeInfo(TypeOf.Class, create:() => PersonSideBarRequest()),
});
Dart PersonSideBarRequest 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 /person/{uuid}/sidebar HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PersonSideBarRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<uuid>String</uuid>
</PersonSideBarRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PersonSideBarResponse 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>
<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>
<imageBase64>String</imageBase64>
<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>
<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>
<regent_login>String</regent_login>
<state>String</state>
<tax_number>String</tax_number>
<ubc_id>0</ubc_id>
<uuid>String</uuid>
</PersonSideBarResponse>