regis

BioHistoryRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/admissions/{uuid}/bio/history

"use strict";
export class BioResponse {
    /** @param {{responseStatus?:ResponseStatus,first_name?:string,middle_name?:string,last_name?:string,preferred_name?:string,birth_name?:string,prefix?:string,dob?:string,citizenship?:string,citizenship_code?:string,citizenship_other?:string,permanent_resident?:string,citizenship_other_code?:string,permanent_resident_code?:string,gender?:string,gender_code?:string,marital_status?:string,marital_status_code?:string,deceased_date?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    first_name;
    /** @type {string} */
    middle_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    birth_name;
    /** @type {string} */
    prefix;
    /** @type {?string} */
    dob;
    /** @type {string} */
    citizenship;
    /** @type {string} */
    citizenship_code;
    /** @type {string} */
    citizenship_other;
    /** @type {string} */
    permanent_resident;
    /** @type {string} */
    citizenship_other_code;
    /** @type {string} */
    permanent_resident_code;
    /** @type {string} */
    gender;
    /** @type {string} */
    gender_code;
    /** @type {string} */
    marital_status;
    /** @type {string} */
    marital_status_code;
    /** @type {?string} */
    deceased_date;
    /** @type {string} */
    added_by;
    /** @type {?string} */
    added_date;
    /** @type {string} */
    changed_by;
    /** @type {?string} */
    changed_date;
}
export class BioHistoryResponse {
    /** @param {{responseStatus?:ResponseStatus,uuid?:string,regent_id?:number,bios?:BioResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    uuid;
    /** @type {number} */
    regent_id;
    /** @type {BioResponse[]} */
    bios;
}
export class BioHistoryRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript BioHistoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /admissions/{uuid}/bio/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,
	bios: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			first_name: String,
			middle_name: String,
			last_name: String,
			preferred_name: String,
			birth_name: String,
			prefix: String,
			dob: 0001-01-01,
			citizenship: String,
			citizenship_code: String,
			citizenship_other: String,
			permanent_resident: String,
			citizenship_other_code: String,
			permanent_resident_code: String,
			gender: String,
			gender_code: String,
			marital_status: String,
			marital_status_code: String,
			deceased_date: 0001-01-01,
			added_by: String,
			added_date: 0001-01-01,
			changed_by: String,
			changed_date: 0001-01-01
		}
	]
}