DigiOffice Gateway Web Services

<back to all web services

GetDocumentAttachmentsByEntityType

Requires Authentication
The following routes are available for this service:
GET/api/entity/{EntityType}/{ID}/attachments
<?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 GetDocumentAttachmentsByEntityType implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ID=null,
        /** @var string|null */
        public ?string $EntityType=null,
        /** @var bool|null */
        public ?bool $IncludeSelf=null
    ) {
    }

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

PHP GetDocumentAttachmentsByEntityType 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/entity/{EntityType}/{ID}/attachments HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","DownloadName":"String","LinkTypeDescription":"String","IsPrefferedDocument":false,"IsMainDocument":false,"Link":"String","DetailUrl":"String"}]