Required role: | REGISUserRole |
POST | /person/{uuid}/sidebar |
---|
"use strict";
export class StudentProgramSimpleResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,program_id?:number,program_code?:string,program_name?:string,concentration_code?:string,concentration_name?:string,start_date?:string,end_date?:string,catalog?:string,is_active?:boolean,is_graduated?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {number} */
program_id;
/** @type {string} */
program_code;
/** @type {string} */
program_name;
/** @type {string} */
concentration_code;
/** @type {string} */
concentration_name;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {string} */
catalog;
/** @type {boolean} */
is_active;
/** @type {boolean} */
is_graduated;
}
export class PersonSideBarResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,ubc_id?:number,regent_login?:string,uuid?:string,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,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?:string,programs?:StudentProgramSimpleResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {?number} */
ubc_id;
/** @type {string} */
regent_login;
/** @type {string} */
uuid;
/** @type {string} */
first_name;
/** @type {string} */
middle_name;
/** @type {string} */
last_name;
/** @type {string} */
preferred_name;
/** @type {?string} */
dob;
/** @type {string} */
citizenship;
/** @type {string} */
citizenship_other;
/** @type {string} */
permanent_resident;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
code;
/** @type {string} */
country;
/** @type {string} */
email;
/** @type {string} */
phone_home;
/** @type {string} */
phone_cell;
/** @type {string} */
phone_bus;
/** @type {string} */
imageBase64;
/** @type {string} */
tax_number;
/** @type {StudentProgramSimpleResponse[]} */
programs;
}
export class PersonSideBarRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript 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>