DigiOffice API Services Services

<back to all web services

GetDocumentsCount

Requires Authentication
The following routes are available for this service:
GET POST/api/documents/count
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetDocumentsCount : IModifiedSince, ISearchCriteria
{
    open var ViewID:UUID? = null
    open var PageSize:Int? = null
    open var PageNumber:Int? = null
    override var SearchCriteria:String? = null
    open var ExplorerID:UUID? = null
    open var Path:String? = null
    open var ExternalNumber:String? = null
    override var ModifiedSince:Date? = null
    open var AllVersions:Boolean? = null
    open var Archived:Boolean? = null
    open var FilterName:String? = null
    open var ProgCode:String? = null
    open var RegistrationProfileFieldID:UUID? = null
    open var DependableFields:ArrayList<RegistrationProfileFieldValue>? = null
}

open class RegistrationProfileFieldValue
{
    open var DocumentFieldID:UUID? = null
    open var Value:String? = null
    open var ShadowValue:String? = null
    open var IsModifiedByUser:Boolean? = null
}

Kotlin GetDocumentsCount DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents/count HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ViewID":"00000000-0000-0000-0000-000000000000","PageSize":0,"PageNumber":0,"SearchCriteria":"String","ExplorerID":"00000000-0000-0000-0000-000000000000","Path":"String","ExternalNumber":"String","ModifiedSince":"0001-01-01T00:00:00.0000000","AllVersions":false,"Archived":false,"FilterName":"String","ProgCode":"String","RegistrationProfileFieldID":"00000000-0000-0000-0000-000000000000","DependableFields":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

0