regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}

export class DirectoryResponse
{
    public directory_uuid: string;
    public waiver: string;
    public bday?: string;
    public spouse_bday?: string;
    public spouse_name: string;
    public wedding_date?: string;
    public kids: string;
    public home_country: string;
    public quote: string;
    public bio: string;
    public interests: string;
    public category: string;
    public field_of_work: string;
    public church: string;

    public constructor(init?: Partial<DirectoryResponse>) { (Object as any).assign(this, init); }
}

export class DirectoryShareSettingsResponse
{
    public directory_uuid: string;
    public share_full_name: boolean;
    public share_bday: boolean;
    public share_home_phone: boolean;
    public share_cell_phone: boolean;
    public share_email: boolean;
    public share_address: boolean;
    public share_quote: boolean;
    public share_bio: boolean;
    public share_interests: boolean;
    public share_home_country: boolean;
    public share_program: boolean;
    public share_picture: boolean;
    public share_spouse_name: boolean;
    public share_spouse_bday: boolean;
    public share_wedding_date: boolean;
    public share_kids: boolean;
    public share_field_of_work: boolean;
    public share_church: boolean;

    public constructor(init?: Partial<DirectoryShareSettingsResponse>) { (Object as any).assign(this, init); }
}

export class DirectoryPersonLookupResponse
{
    public directory_uuid: string;
    public name: string;
    public is_active: boolean;

    public constructor(init?: Partial<DirectoryPersonLookupResponse>) { (Object as any).assign(this, init); }
}

export class DirectorySettingsAndPersonLookupResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public directory_settings: DirectoryResponse;
    public directory_share_settings: DirectoryShareSettingsResponse;
    public person_lookup: DirectoryPersonLookupResponse[];

    public constructor(init?: Partial<DirectorySettingsAndPersonLookupResponse>) { (Object as any).assign(this, init); }
}

export class DirectorySettingsAndActivePersonLookupRequest
{
    public uuid: string;

    public constructor(init?: Partial<DirectorySettingsAndActivePersonLookupRequest>) { (Object as any).assign(this, init); }
}

TypeScript DirectorySettingsAndActivePersonLookupRequest DTOs

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}]}