regis

<back to all web services

BioHistoryRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/history
BioHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
BioHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
uuidformstringNo
regent_idformintNo
biosformList<BioResponse>No
BioResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
preferred_nameformstringNo
birth_nameformstringNo
prefixformstringNo
dobformDateTime?No
citizenshipformstringNo
citizenship_codeformstringNo
citizenship_otherformstringNo
permanent_residentformstringNo
citizenship_other_codeformstringNo
permanent_resident_codeformstringNo
genderformstringNo
gender_codeformstringNo
marital_statusformstringNo
marital_status_codeformstringNo
deceased_dateformDateTime?No
added_byformstringNo
added_dateformDateTime?No
changed_byformstringNo
changed_dateformDateTime?No

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
		}
	]
}