ImzagerServices

GetDocumentFlowInfo

The following routes are available for this service:
All Verbs	/GetDocumentFlowInfo/{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 FlowSignerInfo implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $FlowOrder=null,
        /** @var string|null */
        public ?string $UserName=null,
        /** @var string|null */
        public ?string $UserSsn=null,
        /** @var DateTime */
        public DateTime $ApproveDate=new DateTime(),
        /** @var string|null */
        public ?string $SignerType=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['FlowOrder'])) $this->FlowOrder = $o['FlowOrder'];
        if (isset($o['UserName'])) $this->UserName = $o['UserName'];
        if (isset($o['UserSsn'])) $this->UserSsn = $o['UserSsn'];
        if (isset($o['ApproveDate'])) $this->ApproveDate = JsonConverters::from('DateTime', $o['ApproveDate']);
        if (isset($o['SignerType'])) $this->SignerType = $o['SignerType'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->FlowOrder)) $o['FlowOrder'] = $this->FlowOrder;
        if (isset($this->UserName)) $o['UserName'] = $this->UserName;
        if (isset($this->UserSsn)) $o['UserSsn'] = $this->UserSsn;
        if (isset($this->ApproveDate)) $o['ApproveDate'] = JsonConverters::to('DateTime', $this->ApproveDate);
        if (isset($this->SignerType)) $o['SignerType'] = $this->SignerType;
        return empty($o) ? new class(){} : $o;
    }
}

class DocumentFlowInfo implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $FlowIsExist=null,
        /** @var bool|null */
        public ?bool $FlowIsAvtice=null,
        /** @var bool|null */
        public ?bool $FlowIsCompleted=null,
        /** @var int */
        public int $DocumentID=0,
        /** @var string|null */
        public ?string $DoumentName=null,
        /** @var string|null */
        public ?string $FlowStatus=null,
        /** @var array<FlowSignerInfo>|null */
        public ?array $Signers=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FlowIsExist'])) $this->FlowIsExist = $o['FlowIsExist'];
        if (isset($o['FlowIsAvtice'])) $this->FlowIsAvtice = $o['FlowIsAvtice'];
        if (isset($o['FlowIsCompleted'])) $this->FlowIsCompleted = $o['FlowIsCompleted'];
        if (isset($o['DocumentID'])) $this->DocumentID = $o['DocumentID'];
        if (isset($o['DoumentName'])) $this->DoumentName = $o['DoumentName'];
        if (isset($o['FlowStatus'])) $this->FlowStatus = $o['FlowStatus'];
        if (isset($o['Signers'])) $this->Signers = JsonConverters::fromArray('FlowSignerInfo', $o['Signers']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FlowIsExist)) $o['FlowIsExist'] = $this->FlowIsExist;
        if (isset($this->FlowIsAvtice)) $o['FlowIsAvtice'] = $this->FlowIsAvtice;
        if (isset($this->FlowIsCompleted)) $o['FlowIsCompleted'] = $this->FlowIsCompleted;
        if (isset($this->DocumentID)) $o['DocumentID'] = $this->DocumentID;
        if (isset($this->DoumentName)) $o['DoumentName'] = $this->DoumentName;
        if (isset($this->FlowStatus)) $o['FlowStatus'] = $this->FlowStatus;
        if (isset($this->Signers)) $o['Signers'] = JsonConverters::toArray('FlowSignerInfo', $this->Signers);
        return empty($o) ? new class(){} : $o;
    }
}

class GetDocumentFlowInfoResponse implements JsonSerializable
{
    public function __construct(
        /** @var DocumentFlowInfo|null */
        public ?DocumentFlowInfo $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('DocumentFlowInfo', $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('DocumentFlowInfo', $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 GetDocumentFlowInfo implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ClientKey=null,
        /** @var string|null */
        public ?string $AuthorizationID=null,
        /** @var int */
        public int $DocID=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['DocID'])) $this->DocID = $o['DocID'];
    }
    
    /** @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->DocID)) $o['DocID'] = $this->DocID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetDocumentFlowInfo DTOs

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

HTTP + CSV

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

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

{"ClientKey":"String","AuthorizationID":"String","DocID":0}

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

{"Result":{"FlowIsExist":false,"FlowIsAvtice":false,"FlowIsCompleted":false,"DocumentID":0,"DoumentName":"String","FlowStatus":"String","Signers":[{"Status":"String","FlowOrder":"String","UserName":"String","UserSsn":"String","ApproveDate":"\/Date(-62135596800000-0000)\/","SignerType":"String"}]},"ServiceSuccessResult":false,"ErrorMesage":"String"}