Required role: | REGISUserRole |
POST | /admissions/{uuid}/name/history |
---|
"use strict";
export class NameResponse {
/** @param {{responseStatus?:ResponseStatus,first_name?:string,last_name?:string,middle_name?:string,preferred_name?:string,prefix?:string,created_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
middle_name;
/** @type {string} */
preferred_name;
/** @type {string} */
prefix;
/** @type {?string} */
created_date;
}
export class NameHistoryResponse {
/** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,names?:NameResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
uuid;
/** @type {number} */
regent_id;
/** @type {NameResponse[]} */
names;
}
export class NameHistoryRequest {
/** @param {{uuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
}
JavaScript NameHistoryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /admissions/{uuid}/name/history HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, uuid: String, regent_id: 0, names: [ { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, first_name: String, last_name: String, middle_name: String, preferred_name: String, prefix: String, created_date: 0001-01-01 } ] }