DigiOffice Gateway Web Services

<back to all web services

GetImage

Requires Authentication
<?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 GetImage implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ImageID='',
        /** @var string|null */
        public ?string $FileName=null,
        /** @var ByteArray|null */
        public ?ByteArray $Image=null,
        /** @var DateTime */
        public DateTime $LastUpdate=new DateTime()
    ) {
    }

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

PHP GetImage DTOs

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

HTTP + JSV

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

POST /jsv/reply/GetImage HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	Image: AA==,
	LastUpdate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	FileName: String,
	Image: AA==,
	LastUpdate: 0001-01-01
}