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 .jsv suffix or ?format=jsv

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