| 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 .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: doapigw.baasbv.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>