| POST | /api/documents/search |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
public static class GetDocumentSearch implements IDocumentSearchCriteria
{
public String SearchCriteria = null;
public Integer PageNumber = null;
public Integer PageSize = null;
public ArrayList<UUID> ExcludeID = null;
public Boolean AllVersions = null;
public Boolean Archived = null;
public String getSearchCriteria() { return SearchCriteria; }
public GetDocumentSearch setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
public Integer getPageNumber() { return PageNumber; }
public GetDocumentSearch setPageNumber(Integer value) { this.PageNumber = value; return this; }
public Integer getPageSize() { return PageSize; }
public GetDocumentSearch setPageSize(Integer value) { this.PageSize = value; return this; }
public ArrayList<UUID> getExcludeID() { return ExcludeID; }
public GetDocumentSearch setExcludeID(ArrayList<UUID> value) { this.ExcludeID = value; return this; }
public Boolean isAllVersions() { return AllVersions; }
public GetDocumentSearch setAllVersions(Boolean value) { this.AllVersions = value; return this; }
public Boolean isArchived() { return Archived; }
public GetDocumentSearch setArchived(Boolean value) { this.Archived = value; return this; }
}
public static class SearchResult<DocumentIdentifier, UUID>
{
public ArrayList<DocumentIdentifier> Results = null;
public Integer Total = null;
public ArrayList<DocumentIdentifier> getResults() { return Results; }
public SearchResult<DocumentIdentifier, UUID> setResults(ArrayList<DocumentIdentifier> value) { this.Results = value; return this; }
public Integer getTotal() { return Total; }
public SearchResult<DocumentIdentifier, UUID> setTotal(Integer value) { this.Total = value; return this; }
}
public static class DocumentIdentifier
{
public UUID ID = null;
public String DisplayName = null;
public UUID getId() { return ID; }
public DocumentIdentifier setId(UUID value) { this.ID = value; return this; }
public String getDisplayName() { return DisplayName; }
public DocumentIdentifier setDisplayName(String value) { this.DisplayName = value; return this; }
}
}
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>