regis

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 .xml suffix or ?format=xml

HTTP + XML

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

<DirectoryPersonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <directory_uuid>String</directory_uuid>
</DirectoryPersonRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DirectoryPersonResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <bday>0001-01-01T00:00:00</bday>
  <bio>String</bio>
  <category>String</category>
  <church>String</church>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <directory_uuid>String</directory_uuid>
  <email>String</email>
  <field_of_work>String</field_of_work>
  <home_country>String</home_country>
  <imageBase64>String</imageBase64>
  <interests>String</interests>
  <is_faculty>false</is_faculty>
  <is_staff>false</is_staff>
  <is_student>false</is_student>
  <kids>String</kids>
  <last_name>String</last_name>
  <phone_cell>String</phone_cell>
  <phone_home>String</phone_home>
  <preferred_name>String</preferred_name>
  <program>String</program>
  <quote>String</quote>
  <spouse_bday>0001-01-01T00:00:00</spouse_bday>
  <spouse_name>String</spouse_name>
  <state>String</state>
  <waiver>String</waiver>
  <wedding_date>0001-01-01T00:00:00</wedding_date>
</DirectoryPersonResponse>