regis

<back to all web services

DirectoryImageUploadRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/directory/{uuid}/image/upload
<?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 DirectoryImageUploadRequest implements JsonSerializable
{
    public function __construct(
        /** @var ByteArray|null */
        public ?ByteArray $file=null,
        /** @var string|null */
        public ?string $file_base64=null,
        /** @var string|null */
        public ?string $uuid=null,
        /** @var string|null */
        public ?string $contentType=null
    ) {
    }

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

PHP DirectoryImageUploadRequest 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/{uuid}/image/upload HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"file":"AA==","file_base64":"String","uuid":"String","contentType":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}