regis

<back to all web services

DirectoryPersonRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/{directory_uuid}
"use strict";
export class DirectoryPersonResponse {
    /** @param {{responseStatus?:ResponseStatus,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,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?:boolean,is_staff?:boolean,is_faculty?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @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} */
    imageBase64;
    /** @type {string} */
    preferred_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    email;
    /** @type {string} */
    phone_home;
    /** @type {string} */
    phone_cell;
    /** @type {string} */
    program;
    /** @type {string} */
    field_of_work;
    /** @type {string} */
    church;
    /** @type {boolean} */
    is_student;
    /** @type {boolean} */
    is_staff;
    /** @type {boolean} */
    is_faculty;
}
export class DirectoryPersonRequest {
    /** @param {{directory_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    directory_uuid;
}

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