DigiOffice API Services Services

GetLinkedDocuments

The following routes are available for this service:
GET	/api/documents/{DocumentID}/linkeddocuments

<?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 GetLinkedDocuments implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $DocumentID=''
    ) {
    }

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

PHP GetLinkedDocuments DTOs

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

HTTP + XML

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

GET /api/documents/{DocumentID}/linkeddocuments HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfLinkedDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <LinkedDocument>
    <DocumentDate>0001-01-01T00:00:00</DocumentDate>
    <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
    <DocumentMostRecentVersion>false</DocumentMostRecentVersion>
    <DocumentNumber>String</DocumentNumber>
    <DocumentTitle>String</DocumentTitle>
    <DocumentUserTitle>String</DocumentUserTitle>
    <DocumentVersion>String</DocumentVersion>
    <EntityTitle>String</EntityTitle>
    <FileType>String</FileType>
    <FileUrl>String</FileUrl>
    <ID>String</ID>
    <ShippingFormID>0</ShippingFormID>
  </LinkedDocument>
</ArrayOfLinkedDocument>