regis

<back to all web services

DirectoryShareUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Share/{directory_uuid}/Save
DirectoryShareUpdateRequest Parameters:
NameParameterData TypeRequiredDescription
directory_uuidpathstringNo
share_full_namebodyboolNo
share_bdaybodyboolNo
share_home_phonebodyboolNo
share_cell_phonebodyboolNo
share_emailbodyboolNo
share_addressbodyboolNo
share_quotebodyboolNo
share_biobodyboolNo
share_interestsbodyboolNo
share_home_countrybodyboolNo
share_programbodyboolNo
share_picturebodyboolNo
share_spouse_namebodyboolNo
share_spouse_bdaybodyboolNo
share_wedding_datebodyboolNo
share_kidsbodyboolNo
share_field_of_workbodyboolNo
share_churchbodyboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Directory/Share/{directory_uuid}/Save HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"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}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}