ImzagerServices

DownloadDocument

The following routes are available for this service:
All Verbs	/DownloadDocument/{ClientKey}

<?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 DownloadDocumentResponse implements JsonSerializable
{
    public function __construct(
        /** @var ByteArray|null */
        public ?ByteArray $Result=null,
        /** @var bool|null */
        public ?bool $ServiceSuccessResult=null,
        /** @var string|null */
        public ?string $ErrorMesage=null
    ) {
    }

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

class DownloadDocument implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ClientKey=null,
        /** @var string|null */
        public ?string $AuthorizationID=null,
        /** @var string|null */
        public ?string $UserSSN=null,
        /** @var int */
        public int $DocumentId=0
    ) {
    }

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

PHP DownloadDocument DTOs

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

HTTP + OTHER

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

POST /DownloadDocument/{ClientKey} HTTP/1.1 
Host: imzagerservices.eyyubiye.bel.tr 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ClientKey":"String","AuthorizationID":"String","UserSSN":"String","DocumentId":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Result":"AA==","ServiceSuccessResult":false,"ErrorMesage":"String"}