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 .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/Settings/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DirectorySettingsAndActivePersonLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</DirectorySettingsAndActivePersonLookupRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DirectorySettingsAndPersonLookupResponse 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>
  <directory_settings>
    <bday>0001-01-01T00:00:00</bday>
    <bio>String</bio>
    <category>String</category>
    <church>String</church>
    <directory_uuid>String</directory_uuid>
    <field_of_work>String</field_of_work>
    <home_country>String</home_country>
    <interests>String</interests>
    <kids>String</kids>
    <quote>String</quote>
    <spouse_bday>0001-01-01T00:00:00</spouse_bday>
    <spouse_name>String</spouse_name>
    <waiver>String</waiver>
    <wedding_date>0001-01-01T00:00:00</wedding_date>
  </directory_settings>
  <directory_share_settings>
    <directory_uuid>String</directory_uuid>
    <share_address>false</share_address>
    <share_bday>false</share_bday>
    <share_bio>false</share_bio>
    <share_cell_phone>false</share_cell_phone>
    <share_church>false</share_church>
    <share_email>false</share_email>
    <share_field_of_work>false</share_field_of_work>
    <share_full_name>false</share_full_name>
    <share_home_country>false</share_home_country>
    <share_home_phone>false</share_home_phone>
    <share_interests>false</share_interests>
    <share_kids>false</share_kids>
    <share_picture>false</share_picture>
    <share_program>false</share_program>
    <share_quote>false</share_quote>
    <share_spouse_bday>false</share_spouse_bday>
    <share_spouse_name>false</share_spouse_name>
    <share_wedding_date>false</share_wedding_date>
  </directory_share_settings>
  <person_lookup>
    <DirectoryPersonLookupResponse>
      <directory_uuid>String</directory_uuid>
      <is_active>false</is_active>
      <name>String</name>
    </DirectoryPersonLookupResponse>
  </person_lookup>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</DirectorySettingsAndPersonLookupResponse>