DigiOffice Gateway Web 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 net.servicestack.client.*


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

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

Kotlin GetDocumentsCount 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/count HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
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-01,
	AllVersions: False,
	Archived: False,
	FilterName: String,
	ProgCode: String,
	DependableFields: 
	[
		{
			Value: String,
			ShadowValue: String,
			IsModifiedByUser: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

0