regis

<back to all web services

DirectoryPersonRequest

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

export class DirectoryPersonResponse
{
    public responseStatus: ResponseStatus;
    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 imageBase64: string;
    public preferred_name: string;
    public last_name: string;
    public addr1: string;
    public addr2: string;
    public city: string;
    public state: string;
    public country: string;
    public code: string;
    public email: string;
    public phone_home: string;
    public phone_cell: string;
    public program: string;
    public field_of_work: string;
    public church: string;
    public is_student: boolean;
    public is_staff: boolean;
    public is_faculty: boolean;

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

export class DirectoryPersonRequest
{
    public directory_uuid: string;

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

TypeScript DirectoryPersonRequest 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/{directory_uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"directory_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"}},"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","imageBase64":"String","preferred_name":"String","last_name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","email":"String","phone_home":"String","phone_cell":"String","program":"String","field_of_work":"String","church":"String","is_student":false,"is_staff":false,"is_faculty":false}