| POST | /api/documents/search |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Common;
using IDB.API.DTO.Document;
namespace IDB.API.DTO.Common
{
public partial class SearchResult<DocumentIdentifier, Guid>
{
public SearchResult()
{
Results = new List<DocumentIdentifier>{};
}
public virtual List<DocumentIdentifier> Results { get; set; }
public virtual int Total { get; set; }
}
}
namespace IDB.API.DTO.Document
{
public partial class DocumentIdentifier
{
public virtual Guid ID { get; set; }
public virtual string DisplayName { get; set; }
}
}
namespace IDB.API.DTO.Document.Operations
{
public partial class GetDocumentSearch
: IDocumentSearchCriteria
{
public GetDocumentSearch()
{
ExcludeID = new List<Guid>{};
}
public virtual string SearchCriteria { get; set; }
public virtual int PageNumber { get; set; }
public virtual int PageSize { get; set; }
public virtual List<Guid> ExcludeID { get; set; }
public virtual bool AllVersions { get; set; }
public virtual bool? Archived { get; set; }
}
}
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>