DigiOffice API Services Services

<back to all web services

GetDocumentsCount

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/count
"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 GetDocumentsCount {
    /** @param {{ViewID?:string,PageSize?:number,PageNumber?:number,SearchCriteria?:string,ExplorerID?:string,Path?:string,ExternalNumber?:string,ModifiedSince?:string,AllVersions?:boolean,Archived?:boolean,FilterName?:string,ProgCode?:string,RegistrationProfileFieldID?:string,DependableFields?:RegistrationProfileFieldValue[]}} [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 {?boolean} */
    Archived;
    /** @type {string} */
    FilterName;
    /** @type {string} */
    ProgCode;
    /** @type {string} */
    RegistrationProfileFieldID;
    /** @type {RegistrationProfileFieldValue[]} */
    DependableFields;
}

JavaScript GetDocumentsCount DTOs

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

HTTP + JSV

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

POST /api/documents/count HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
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-01,
	AllVersions: False,
	Archived: False,
	FilterName: String,
	ProgCode: String,
	DependableFields: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	]
}

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

0