regis

<back to all web services

DirectorySettingsAndActivePersonLookupRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Settings/{uuid}
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class DirectoryResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $directory_uuid=null,
        /** @var string|null */
        public ?string $waiver=null,
        /** @var DateTime|null */
        public ?DateTime $bday=null,
        /** @var DateTime|null */
        public ?DateTime $spouse_bday=null,
        /** @var string|null */
        public ?string $spouse_name=null,
        /** @var DateTime|null */
        public ?DateTime $wedding_date=null,
        /** @var string|null */
        public ?string $kids=null,
        /** @var string|null */
        public ?string $home_country=null,
        /** @var string|null */
        public ?string $quote=null,
        /** @var string|null */
        public ?string $bio=null,
        /** @var string|null */
        public ?string $interests=null,
        /** @var string|null */
        public ?string $category=null,
        /** @var string|null */
        public ?string $field_of_work=null,
        /** @var string|null */
        public ?string $church=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['directory_uuid'])) $this->directory_uuid = $o['directory_uuid'];
        if (isset($o['waiver'])) $this->waiver = $o['waiver'];
        if (isset($o['bday'])) $this->bday = JsonConverters::from('DateTime', $o['bday']);
        if (isset($o['spouse_bday'])) $this->spouse_bday = JsonConverters::from('DateTime', $o['spouse_bday']);
        if (isset($o['spouse_name'])) $this->spouse_name = $o['spouse_name'];
        if (isset($o['wedding_date'])) $this->wedding_date = JsonConverters::from('DateTime', $o['wedding_date']);
        if (isset($o['kids'])) $this->kids = $o['kids'];
        if (isset($o['home_country'])) $this->home_country = $o['home_country'];
        if (isset($o['quote'])) $this->quote = $o['quote'];
        if (isset($o['bio'])) $this->bio = $o['bio'];
        if (isset($o['interests'])) $this->interests = $o['interests'];
        if (isset($o['category'])) $this->category = $o['category'];
        if (isset($o['field_of_work'])) $this->field_of_work = $o['field_of_work'];
        if (isset($o['church'])) $this->church = $o['church'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->directory_uuid)) $o['directory_uuid'] = $this->directory_uuid;
        if (isset($this->waiver)) $o['waiver'] = $this->waiver;
        if (isset($this->bday)) $o['bday'] = JsonConverters::to('DateTime', $this->bday);
        if (isset($this->spouse_bday)) $o['spouse_bday'] = JsonConverters::to('DateTime', $this->spouse_bday);
        if (isset($this->spouse_name)) $o['spouse_name'] = $this->spouse_name;
        if (isset($this->wedding_date)) $o['wedding_date'] = JsonConverters::to('DateTime', $this->wedding_date);
        if (isset($this->kids)) $o['kids'] = $this->kids;
        if (isset($this->home_country)) $o['home_country'] = $this->home_country;
        if (isset($this->quote)) $o['quote'] = $this->quote;
        if (isset($this->bio)) $o['bio'] = $this->bio;
        if (isset($this->interests)) $o['interests'] = $this->interests;
        if (isset($this->category)) $o['category'] = $this->category;
        if (isset($this->field_of_work)) $o['field_of_work'] = $this->field_of_work;
        if (isset($this->church)) $o['church'] = $this->church;
        return empty($o) ? new class(){} : $o;
    }
}

class DirectoryShareSettingsResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $directory_uuid=null,
        /** @var bool|null */
        public ?bool $share_full_name=null,
        /** @var bool|null */
        public ?bool $share_bday=null,
        /** @var bool|null */
        public ?bool $share_home_phone=null,
        /** @var bool|null */
        public ?bool $share_cell_phone=null,
        /** @var bool|null */
        public ?bool $share_email=null,
        /** @var bool|null */
        public ?bool $share_address=null,
        /** @var bool|null */
        public ?bool $share_quote=null,
        /** @var bool|null */
        public ?bool $share_bio=null,
        /** @var bool|null */
        public ?bool $share_interests=null,
        /** @var bool|null */
        public ?bool $share_home_country=null,
        /** @var bool|null */
        public ?bool $share_program=null,
        /** @var bool|null */
        public ?bool $share_picture=null,
        /** @var bool|null */
        public ?bool $share_spouse_name=null,
        /** @var bool|null */
        public ?bool $share_spouse_bday=null,
        /** @var bool|null */
        public ?bool $share_wedding_date=null,
        /** @var bool|null */
        public ?bool $share_kids=null,
        /** @var bool|null */
        public ?bool $share_field_of_work=null,
        /** @var bool|null */
        public ?bool $share_church=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['directory_uuid'])) $this->directory_uuid = $o['directory_uuid'];
        if (isset($o['share_full_name'])) $this->share_full_name = $o['share_full_name'];
        if (isset($o['share_bday'])) $this->share_bday = $o['share_bday'];
        if (isset($o['share_home_phone'])) $this->share_home_phone = $o['share_home_phone'];
        if (isset($o['share_cell_phone'])) $this->share_cell_phone = $o['share_cell_phone'];
        if (isset($o['share_email'])) $this->share_email = $o['share_email'];
        if (isset($o['share_address'])) $this->share_address = $o['share_address'];
        if (isset($o['share_quote'])) $this->share_quote = $o['share_quote'];
        if (isset($o['share_bio'])) $this->share_bio = $o['share_bio'];
        if (isset($o['share_interests'])) $this->share_interests = $o['share_interests'];
        if (isset($o['share_home_country'])) $this->share_home_country = $o['share_home_country'];
        if (isset($o['share_program'])) $this->share_program = $o['share_program'];
        if (isset($o['share_picture'])) $this->share_picture = $o['share_picture'];
        if (isset($o['share_spouse_name'])) $this->share_spouse_name = $o['share_spouse_name'];
        if (isset($o['share_spouse_bday'])) $this->share_spouse_bday = $o['share_spouse_bday'];
        if (isset($o['share_wedding_date'])) $this->share_wedding_date = $o['share_wedding_date'];
        if (isset($o['share_kids'])) $this->share_kids = $o['share_kids'];
        if (isset($o['share_field_of_work'])) $this->share_field_of_work = $o['share_field_of_work'];
        if (isset($o['share_church'])) $this->share_church = $o['share_church'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->directory_uuid)) $o['directory_uuid'] = $this->directory_uuid;
        if (isset($this->share_full_name)) $o['share_full_name'] = $this->share_full_name;
        if (isset($this->share_bday)) $o['share_bday'] = $this->share_bday;
        if (isset($this->share_home_phone)) $o['share_home_phone'] = $this->share_home_phone;
        if (isset($this->share_cell_phone)) $o['share_cell_phone'] = $this->share_cell_phone;
        if (isset($this->share_email)) $o['share_email'] = $this->share_email;
        if (isset($this->share_address)) $o['share_address'] = $this->share_address;
        if (isset($this->share_quote)) $o['share_quote'] = $this->share_quote;
        if (isset($this->share_bio)) $o['share_bio'] = $this->share_bio;
        if (isset($this->share_interests)) $o['share_interests'] = $this->share_interests;
        if (isset($this->share_home_country)) $o['share_home_country'] = $this->share_home_country;
        if (isset($this->share_program)) $o['share_program'] = $this->share_program;
        if (isset($this->share_picture)) $o['share_picture'] = $this->share_picture;
        if (isset($this->share_spouse_name)) $o['share_spouse_name'] = $this->share_spouse_name;
        if (isset($this->share_spouse_bday)) $o['share_spouse_bday'] = $this->share_spouse_bday;
        if (isset($this->share_wedding_date)) $o['share_wedding_date'] = $this->share_wedding_date;
        if (isset($this->share_kids)) $o['share_kids'] = $this->share_kids;
        if (isset($this->share_field_of_work)) $o['share_field_of_work'] = $this->share_field_of_work;
        if (isset($this->share_church)) $o['share_church'] = $this->share_church;
        return empty($o) ? new class(){} : $o;
    }
}

class DirectoryPersonLookupResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $directory_uuid=null,
        /** @var string|null */
        public ?string $name=null,
        /** @var bool|null */
        public ?bool $is_active=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['directory_uuid'])) $this->directory_uuid = $o['directory_uuid'];
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['is_active'])) $this->is_active = $o['is_active'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->directory_uuid)) $o['directory_uuid'] = $this->directory_uuid;
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->is_active)) $o['is_active'] = $this->is_active;
        return empty($o) ? new class(){} : $o;
    }
}

class DirectorySettingsAndPersonLookupResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $regent_id=0,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var DirectoryResponse|null */
        public ?DirectoryResponse $directory_settings=null,
        /** @var DirectoryShareSettingsResponse|null */
        public ?DirectoryShareSettingsResponse $directory_share_settings=null,
        /** @var array<DirectoryPersonLookupResponse>|null */
        public ?array $person_lookup=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
        if (isset($o['directory_settings'])) $this->directory_settings = JsonConverters::from('DirectoryResponse', $o['directory_settings']);
        if (isset($o['directory_share_settings'])) $this->directory_share_settings = JsonConverters::from('DirectoryShareSettingsResponse', $o['directory_share_settings']);
        if (isset($o['person_lookup'])) $this->person_lookup = JsonConverters::fromArray('DirectoryPersonLookupResponse', $o['person_lookup']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        if (isset($this->directory_settings)) $o['directory_settings'] = JsonConverters::to('DirectoryResponse', $this->directory_settings);
        if (isset($this->directory_share_settings)) $o['directory_share_settings'] = JsonConverters::to('DirectoryShareSettingsResponse', $this->directory_share_settings);
        if (isset($this->person_lookup)) $o['person_lookup'] = JsonConverters::toArray('DirectoryPersonLookupResponse', $this->person_lookup);
        return empty($o) ? new class(){} : $o;
    }
}

class DirectorySettingsAndActivePersonLookupRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $uuid=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['uuid'])) $this->uuid = $o['uuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->uuid)) $o['uuid'] = $this->uuid;
        return empty($o) ? new class(){} : $o;
    }
}

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