DigiOffice API Services Services

<back to all web services

GetDocumentUploadFile

Returns a byte array of the document to be registered

<?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};


/** @description Returns a byte array of the document to be registered */
// @Api(Description="Returns a byte array of the document to be registered")
// @ApiResponse(Description="File is in the message body", StatusCode=200)
// @ApiResponse(Description="Unauthorized to read or download documentupload", StatusCode=401)
// @ApiResponse(Description="Documentupload not found", StatusCode=410)
class GetDocumentUploadFile implements JsonSerializable
{
    public function __construct(
        /** @description Documentupload ID */
        // @ApiMember(Description="Documentupload ID", IsRequired=true)
        /** @var int */
        public int $ID=0
    ) {
    }

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

PHP GetDocumentUploadFile DTOs

GET /api/documentuploads/{ID}/download HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv

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

(byte[])