DigiOffice API Services Services

GetDocumentSearch

The following routes are available for this service:
POST	/api/documents/search

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetDocumentSearch : IDocumentSearchCriteria
{
    open var SearchCriteria:String? = null
    open var PageNumber:Int? = null
    open var PageSize:Int? = null
    open var ExcludeID:ArrayList<UUID>? = null
    override var AllVersions:Boolean? = null
    override var Archived:Boolean? = null
}

open class SearchResult<T, TPrimaryKey>
{
    open var Results:ArrayList<DocumentIdentifier>? = null
    open var Total:Int? = null
}

open class DocumentIdentifier
{
    open var ID:UUID? = null
    open var DisplayName:String? = null
}

Kotlin GetDocumentSearch DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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: test-do-services.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>