DigiOffice API Services Services

<back to all web services

GetFavoriteDocuments

Requires Authentication
The following routes are available for this service:
GET/api/me/documents/favorites
"use strict";
export class GetFavoriteDocuments {
    /** @param {{PageNumber?:number,PageSize?:number,FileExtensions?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PageNumber;
    /** @type {number} */
    PageSize;
    /** @type {string[]} */
    FileExtensions;
}

JavaScript GetFavoriteDocuments DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

[{"Document":{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"InternalLocationID":0,"LanguageID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}},"Date":"0001-01-01T00:00:00.0000000","ModifiedDate":"0001-01-01T00:00:00.0000000"}]