regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}
DirectorySettingsAndActivePersonLookupRequest Parameters:
NameParameterData TypeRequiredDescription
uuidpathstringNo
DirectorySettingsAndPersonLookupResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
regent_idformintNo
uuidformstringNo
directory_settingsformDirectoryResponseNo
directory_share_settingsformDirectoryShareSettingsResponseNo
person_lookupformList<DirectoryPersonLookupResponse>No
DirectoryResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
waiverformstringNo
bdayformDateTime?No
spouse_bdayformDateTime?No
spouse_nameformstringNo
wedding_dateformDateTime?No
kidsformstringNo
home_countryformstringNo
quoteformstringNo
bioformstringNo
interestsformstringNo
categoryformstringNo
field_of_workformstringNo
churchformstringNo
DirectoryShareSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
share_full_nameformboolNo
share_bdayformboolNo
share_home_phoneformboolNo
share_cell_phoneformboolNo
share_emailformboolNo
share_addressformboolNo
share_quoteformboolNo
share_bioformboolNo
share_interestsformboolNo
share_home_countryformboolNo
share_programformboolNo
share_pictureformboolNo
share_spouse_nameformboolNo
share_spouse_bdayformboolNo
share_wedding_dateformboolNo
share_kidsformboolNo
share_field_of_workformboolNo
share_churchformboolNo
DirectoryPersonLookupResponse Parameters:
NameParameterData TypeRequiredDescription
directory_uuidformstringNo
nameformstringNo
is_activeformboolNo

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/Settings/{uuid} 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
		}
	},
	regent_id: 0,
	uuid: String,
	directory_settings: 
	{
		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,
		field_of_work: String,
		church: String
	},
	directory_share_settings: 
	{
		directory_uuid: String,
		share_full_name: False,
		share_bday: False,
		share_home_phone: False,
		share_cell_phone: False,
		share_email: False,
		share_address: False,
		share_quote: False,
		share_bio: False,
		share_interests: False,
		share_home_country: False,
		share_program: False,
		share_picture: False,
		share_spouse_name: False,
		share_spouse_bday: False,
		share_wedding_date: False,
		share_kids: False,
		share_field_of_work: False,
		share_church: False
	},
	person_lookup: 
	[
		{
			directory_uuid: String,
			name: String,
			is_active: False
		}
	]
}