regis

<back to all web services

BioSyncUpdateWithValuesRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/sync/update/withvalues
BioSyncUpdateWithValuesRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
first_namebodystringNo
middle_namebodystringNo
last_namebodystringNo
preferred_namebodystringNo
birth_namebodystringNo
prefixbodystringNo
current_occupationbodystringNo
dobbodyDateTime?No
citizenshipbodystringNo
citizenship_otherbodystringNo
permanent_residentbodystringNo
genderbodystringNo
marital_statusbodystringNo
deceased_datebodyDateTime?No
authorizing_uuidbodystringNo

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/sync/update/withvalues HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	first_name: String,
	middle_name: String,
	last_name: String,
	preferred_name: String,
	birth_name: String,
	prefix: String,
	current_occupation: String,
	dob: 0001-01-01,
	citizenship: String,
	citizenship_other: String,
	permanent_resident: String,
	gender: String,
	marital_status: String,
	deceased_date: 0001-01-01,
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}