Required role: | REGISUserRole |
POST | /Directory/Settings/{uuid} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
regent_id | form | int | No | |
uuid | form | string | No | |
directory_settings | form | DirectoryResponse | No | |
directory_share_settings | form | DirectoryShareSettingsResponse | No | |
person_lookup | form | List<DirectoryPersonLookupResponse> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
directory_uuid | form | string | No | |
waiver | form | string | No | |
bday | form | DateTime? | No | |
spouse_bday | form | DateTime? | No | |
spouse_name | form | string | No | |
wedding_date | form | DateTime? | No | |
kids | form | string | No | |
home_country | form | string | No | |
quote | form | string | No | |
bio | form | string | No | |
interests | form | string | No | |
category | form | string | No | |
field_of_work | form | string | No | |
church | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
directory_uuid | form | string | No | |
share_full_name | form | bool | No | |
share_bday | form | bool | No | |
share_home_phone | form | bool | No | |
share_cell_phone | form | bool | No | |
share_email | form | bool | No | |
share_address | form | bool | No | |
share_quote | form | bool | No | |
share_bio | form | bool | No | |
share_interests | form | bool | No | |
share_home_country | form | bool | No | |
share_program | form | bool | No | |
share_picture | form | bool | No | |
share_spouse_name | form | bool | No | |
share_spouse_bday | form | bool | No | |
share_wedding_date | form | bool | No | |
share_kids | form | bool | No | |
share_field_of_work | form | bool | No | |
share_church | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
directory_uuid | form | string | No | |
name | form | string | No | |
is_active | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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}]}