| 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 .xml suffix or ?format=xml
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: dogw.klokgroep.nl
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetDocumentSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
<AllVersions>false</AllVersions>
<Archived>false</Archived>
<ExcludeID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</ExcludeID>
<PageNumber>0</PageNumber>
<PageSize>0</PageSize>
<SearchCriteria>String</SearchCriteria>
</GetDocumentSearch>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchResultOfDocumentIdentifierguidGNR3VCgI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Common">
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document">
<d2p1:DocumentIdentifier>
<d2p1:DisplayName>String</d2p1:DisplayName>
<d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
</d2p1:DocumentIdentifier>
</Results>
<Total>0</Total>
</SearchResultOfDocumentIdentifierguidGNR3VCgI>