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 .jsv suffix or ?format=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 } ] }