regis

<back to all web services

RegistrationAvailableRequest

Requires Authentication
Required permission:ReadRegistrationAvailability
The following routes are available for this service:
POST/Registration/{reporting_term}/Available
RegistrationAvailableRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
first_namebodystringNo
last_namebodystringNo
emailbodystringNo
dobbodyDateTime?No
regent_idbodyint?No
RegistrationAvailableResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformint?No
birthdate_existsformboolNo
birthdate_matchesformboolNo
has_regent_loginformboolNo
is_a_regis_personformboolNo
is_a_sugar_personformboolNo
term_is_availableformboolNo
blocked_in_regisformboolNo
email_matchesformboolNo

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

{
	reporting_term: String,
	first_name: String,
	last_name: String,
	email: String,
	dob: 0001-01-01,
	regent_id: 0
}
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
		}
	},
	regent_id: 0,
	birthdate_exists: False,
	birthdate_matches: False,
	has_regent_login: False,
	is_a_regis_person: False,
	is_a_sugar_person: False,
	term_is_available: False,
	blocked_in_regis: False,
	email_matches: False
}