regis

<back to all web services

BioSyncUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/admissions/{uuid}/bio/sync/update
BioSyncUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
authorizing_uuidbodystringNo
uuidpathstringNo
sugar_is_bestbodyboolNo
regis_is_bestbodyboolNo
re_is_bestbodyboolNo

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

{
	authorizing_uuid: String,
	uuid: String,
	sugar_is_best: False,
	regis_is_best: False,
	re_is_best: False
}
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
	}
}