regis

<back to all web services

DirectoryImageRequest

Requires Authentication
Required permission:PicturePermission
The following routes are available for this service:
POST/directory/image
<?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 DirectoryImageRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $directory_uuid=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var bool|null */
        public ?bool $large=null,
        /** @var bool|null */
        public ?bool $medium=null,
        /** @var bool|null */
        public ?bool $original_size=null,
        /** @var bool|null */
        public ?bool $ignore_share=null
    ) {
    }

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

PHP DirectoryImageRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /directory/image HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"directory_uuid":"String","uuid":"String","large":false,"medium":false,"original_size":false,"ignore_share":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

(byte[])