DigiOffice API Services Services

<back to all web services

GetDocuments

Requires Authentication
The following routes are available for this service:
GET POST/api/documents
"use strict";
export class RegistrationProfileFieldValue {
    /** @param {{DocumentFieldID?:string,Value?:string,ShadowValue?:string,IsModifiedByUser?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DocumentFieldID;
    /** @type {string} */
    Value;
    /** @type {string} */
    ShadowValue;
    /** @type {boolean} */
    IsModifiedByUser;
}
export class GetDocuments {
    /** @param {{ViewID?:string,PageSize?:number,PageNumber?:number,SearchCriteria?:string,ExplorerID?:string,Path?:string,ExternalNumber?:string,ModifiedSince?:string,AllVersions?:boolean,OrderBy?:string,Archived?:boolean,FilterName?:string,ProgCode?:string,RegistrationProfileFieldID?:string,DependableFields?:RegistrationProfileFieldValue[],IncludeCustomProperties?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    ViewID;
    /** @type {number} */
    PageSize;
    /** @type {number} */
    PageNumber;
    /** @type {string} */
    SearchCriteria;
    /** @type {?string} */
    ExplorerID;
    /** @type {string} */
    Path;
    /** @type {string} */
    ExternalNumber;
    /** @type {?string} */
    ModifiedSince;
    /** @type {boolean} */
    AllVersions;
    /** @type {string} */
    OrderBy;
    /** @type {?boolean} */
    Archived;
    /** @type {string} */
    FilterName;
    /** @type {string} */
    ProgCode;
    /** @type {string} */
    RegistrationProfileFieldID;
    /** @type {RegistrationProfileFieldValue[]} */
    DependableFields;
    /** @type {boolean} */
    IncludeCustomProperties;
}

JavaScript GetDocuments 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.

POST /api/documents HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ViewID":"00000000-0000-0000-0000-000000000000","PageSize":0,"PageNumber":0,"SearchCriteria":"String","ExplorerID":"00000000-0000-0000-0000-000000000000","Path":"String","ExternalNumber":"String","ModifiedSince":"0001-01-01T00:00:00.0000000","AllVersions":false,"OrderBy":"String","Archived":false,"FilterName":"String","ProgCode":"String","RegistrationProfileFieldID":"00000000-0000-0000-0000-000000000000","DependableFields":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IncludeCustomProperties":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"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":{}}}]