| POST | /api/documents/search |
|---|
export class DocumentIdentifier
{
public ID: string;
public DisplayName: string;
public constructor(init?: Partial<DocumentIdentifier>) { (Object as any).assign(this, init); }
}
export class GetDocumentSearch implements IDocumentSearchCriteria
{
public SearchCriteria: string;
public PageNumber: number;
public PageSize: number;
public ExcludeID: string[];
public AllVersions: boolean;
public Archived?: boolean;
public constructor(init?: Partial<GetDocumentSearch>) { (Object as any).assign(this, init); }
}
export class SearchResult<DocumentIdentifier, string>
{
public Results: DocumentIdentifier[];
public Total: number;
public constructor(init?: Partial<SearchResult<DocumentIdentifier, string>>) { (Object as any).assign(this, init); }
}
TypeScript 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: doapigw.baasbv.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
}