DigiOffice Gateway Web Services

<back to all web services

GetDocumentSearch

Requires Authentication
The following routes are available for this service:
POST/api/documents/search
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


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

open class SearchResult<DocumentIdentifier, UUID>
{
    var Results:ArrayList<DocumentIdentifier> = ArrayList<DocumentIdentifier>()
    var Total:Int? = null
}

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

Kotlin GetDocumentSearch DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Results":[{"ID":"00000000-0000-0000-0000-000000000000","DisplayName":"String"}],"Total":0}