regis

<back to all web services

DirectoryPersonRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/{directory_uuid}
DirectoryPersonRequest Parameters:
NameParameterData TypeRequiredDescription
directory_uuidpathstringNo
DirectoryPersonResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
directory_uuidformstringNo
waiverformstringNo
bdayformDateTime?No
spouse_bdayformDateTime?No
spouse_nameformstringNo
wedding_dateformDateTime?No
kidsformstringNo
home_countryformstringNo
quoteformstringNo
bioformstringNo
interestsformstringNo
categoryformstringNo
imageBase64formstringNo
preferred_nameformstringNo
last_nameformstringNo
addr1formstringNo
addr2formstringNo
cityformstringNo
stateformstringNo
countryformstringNo
codeformstringNo
emailformstringNo
phone_homeformstringNo
phone_cellformstringNo
programformstringNo
field_of_workformstringNo
churchformstringNo
is_studentformboolNo
is_staffformboolNo
is_facultyformboolNo

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

{
	directory_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
		}
	},
	directory_uuid: String,
	waiver: String,
	bday: 0001-01-01,
	spouse_bday: 0001-01-01,
	spouse_name: String,
	wedding_date: 0001-01-01,
	kids: String,
	home_country: String,
	quote: String,
	bio: String,
	interests: String,
	category: String,
	imageBase64: String,
	preferred_name: String,
	last_name: String,
	addr1: String,
	addr2: String,
	city: String,
	state: String,
	country: String,
	code: String,
	email: String,
	phone_home: String,
	phone_cell: String,
	program: String,
	field_of_work: String,
	church: String,
	is_student: False,
	is_staff: False,
	is_faculty: False
}