DigiOffice API Services Services

GetFavoriteDocuments

The following routes are available for this service:
GET	/api/me/documents/favorites

<?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 GetFavoriteDocuments implements IPageOptions, JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $PageNumber=0,
        /** @var int */
        public int $PageSize=0,
        /** @var array<string>|null */
        public ?array $FileExtensions=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PageNumber'])) $this->PageNumber = $o['PageNumber'];
        if (isset($o['PageSize'])) $this->PageSize = $o['PageSize'];
        if (isset($o['FileExtensions'])) $this->FileExtensions = JsonConverters::fromArray('string', $o['FileExtensions']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PageNumber)) $o['PageNumber'] = $this->PageNumber;
        if (isset($this->PageSize)) $o['PageSize'] = $this->PageSize;
        if (isset($this->FileExtensions)) $o['FileExtensions'] = JsonConverters::toArray('string', $this->FileExtensions);
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetFavoriteDocuments 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/me/documents/favorites HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

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

<ArrayOfFavoriteDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
  <FavoriteDocument>
    <Date>0001-01-01T00:00:00</Date>
    <Document>
      <AllowDigitalSigningOnlyOnPrimaryVersions>false</AllowDigitalSigningOnlyOnPrimaryVersions>
      <CommentsCount>0</CommentsCount>
      <CustomProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </CustomProperties>
      <Date>0001-01-01T00:00:00</Date>
      <DirectUrl>String</DirectUrl>
      <DocumentcategoryText>String</DocumentcategoryText>
      <Extension>String</Extension>
      <ExternalNumber>String</ExternalNumber>
      <ExternalVersion>String</ExternalVersion>
      <ExtraField>String</ExtraField>
      <FileDate>0001-01-01T00:00:00</FileDate>
      <FileExtension>String</FileExtension>
      <FileSize>0</FileSize>
      <FileUrl>String</FileUrl>
      <FullTitle>String</FullTitle>
      <HasPreview>false</HasPreview>
      <Hash>String</Hash>
      <HashType>String</HashType>
      <ID>00000000-0000-0000-0000-000000000000</ID>
      <InternalCompanyID>0</InternalCompanyID>
      <InternalInvoiceNumber>String</InternalInvoiceNumber>
      <InternalLocationID>0</InternalLocationID>
      <InternalNumber>String</InternalNumber>
      <IsCorporateIdentity>false</IsCorporateIdentity>
      <IsFavorite>false</IsFavorite>
      <IsFrozen>false</IsFrozen>
      <IsPrimaryVersion>false</IsPrimaryVersion>
      <LanguageID>0</LanguageID>
      <Number>String</Number>
      <PersonID>0</PersonID>
      <ProjectID>0</ProjectID>
      <ProjectTitle>String</ProjectTitle>
      <RegistrationprofileID>00000000-0000-0000-0000-000000000000</RegistrationprofileID>
      <RelationID>0</RelationID>
      <RelationTitle>String</RelationTitle>
      <RootDocumentID>00000000-0000-0000-0000-000000000000</RootDocumentID>
      <StandardDocumentUrl>String</StandardDocumentUrl>
      <Title>String</Title>
      <UserTitle>String</UserTitle>
      <Version>String</Version>
    </Document>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
  </FavoriteDocument>
</ArrayOfFavoriteDocument>