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 .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>