| POST | /api/documents/search |
|---|
"use strict";
export class DocumentIdentifier {
/** @param {{ID?:string,DisplayName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ID;
/** @type {string} */
DisplayName;
}
export class GetDocumentSearch {
/** @param {{SearchCriteria?:string,PageNumber?:number,PageSize?:number,ExcludeID?:string[],AllVersions?:boolean,Archived?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SearchCriteria;
/** @type {number} */
PageNumber;
/** @type {number} */
PageSize;
/** @type {string[]} */
ExcludeID;
/** @type {boolean} */
AllVersions;
/** @type {?boolean} */
Archived;
}
/** @typedef T {any} */
/** @typedef TPrimaryKey {any} */
export class SearchResult {
/** @param {{Results?:DocumentIdentifier[],Total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {DocumentIdentifier[]} */
Results;
/** @type {number} */
Total;
}
JavaScript GetDocumentSearch DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents/search HTTP/1.1
Host: test-dogw.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
SearchCriteria: String,
PageNumber: 0,
PageSize: 0,
ExcludeID:
[
00000000-0000-0000-0000-000000000000
],
AllVersions: False,
Archived: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Results:
[
{
DisplayName: String
}
],
Total: 0
}