regis

DirectorySettingsAndActivePersonLookupRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Directory/Settings/{uuid}

"use strict";
export class DirectoryResponse {
    /** @param {{directory_uuid?:string,waiver?:string,bday?:string,spouse_bday?:string,spouse_name?:string,wedding_date?:string,kids?:string,home_country?:string,quote?:string,bio?:string,interests?:string,category?:string,field_of_work?:string,church?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {string} */
    waiver;
    /** @type {?string} */
    bday;
    /** @type {?string} */
    spouse_bday;
    /** @type {string} */
    spouse_name;
    /** @type {?string} */
    wedding_date;
    /** @type {string} */
    kids;
    /** @type {string} */
    home_country;
    /** @type {string} */
    quote;
    /** @type {string} */
    bio;
    /** @type {string} */
    interests;
    /** @type {string} */
    category;
    /** @type {string} */
    field_of_work;
    /** @type {string} */
    church;
}
export class DirectoryShareSettingsResponse {
    /** @param {{directory_uuid?:string,share_full_name?:boolean,share_bday?:boolean,share_home_phone?:boolean,share_cell_phone?:boolean,share_email?:boolean,share_address?:boolean,share_quote?:boolean,share_bio?:boolean,share_interests?:boolean,share_home_country?:boolean,share_program?:boolean,share_picture?:boolean,share_spouse_name?:boolean,share_spouse_bday?:boolean,share_wedding_date?:boolean,share_kids?:boolean,share_field_of_work?:boolean,share_church?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {boolean} */
    share_full_name;
    /** @type {boolean} */
    share_bday;
    /** @type {boolean} */
    share_home_phone;
    /** @type {boolean} */
    share_cell_phone;
    /** @type {boolean} */
    share_email;
    /** @type {boolean} */
    share_address;
    /** @type {boolean} */
    share_quote;
    /** @type {boolean} */
    share_bio;
    /** @type {boolean} */
    share_interests;
    /** @type {boolean} */
    share_home_country;
    /** @type {boolean} */
    share_program;
    /** @type {boolean} */
    share_picture;
    /** @type {boolean} */
    share_spouse_name;
    /** @type {boolean} */
    share_spouse_bday;
    /** @type {boolean} */
    share_wedding_date;
    /** @type {boolean} */
    share_kids;
    /** @type {boolean} */
    share_field_of_work;
    /** @type {boolean} */
    share_church;
}
export class DirectoryPersonLookupResponse {
    /** @param {{directory_uuid?:string,name?:string,is_active?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
    /** @type {string} */
    name;
    /** @type {boolean} */
    is_active;
}
export class DirectorySettingsAndPersonLookupResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,directory_settings?:DirectoryResponse,directory_share_settings?:DirectoryShareSettingsResponse,person_lookup?:DirectoryPersonLookupResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {DirectoryResponse} */
    directory_settings;
    /** @type {DirectoryShareSettingsResponse} */
    directory_share_settings;
    /** @type {DirectoryPersonLookupResponse[]} */
    person_lookup;
}
export class DirectorySettingsAndActivePersonLookupRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript DirectorySettingsAndActivePersonLookupRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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}]}