regis

<back to all web services

DirectoryShareUpdateRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Directory/Share/{directory_uuid}/Save
<?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 DirectoryShareUpdateRequest 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;
    }
}

PHP DirectoryShareUpdateRequest 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/Share/{directory_uuid}/Save HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DirectoryShareUpdateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <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>
</DirectoryShareUpdateRequest>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>