DigiOffice Gateway Web Services

<back to all web services

GetDocumentFileName

Requires Authentication
The following routes are available for this service:
GET/api/documents/{DocumentID}/filename
<?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 GetDocumentFileName implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentID='',
        /** @var bool|null */
        public ?bool $IncludeExtension=null,
        /** @var bool|null */
        public ?bool $IncludeTitle=null
    ) {
    }

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

PHP GetDocumentFileName 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.

GET /api/documents/{DocumentID}/filename HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

(string)