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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","spouse_bday":"0001-01-01T00:00:00.0000000","spouse_name":"String","wedding_date":"0001-01-01T00:00:00.0000000","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}]}