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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationProfileFieldValue:
    document_field_i_d: Optional[str] = None
    value: Optional[str] = None
    shadow_value: Optional[str] = None
    is_modified_by_user: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDocumentsCount:
    view_i_d: Optional[str] = None
    page_size: Optional[int] = None
    page_number: Optional[int] = None
    search_criteria: Optional[str] = None
    explorer_i_d: Optional[str] = None
    path: Optional[str] = None
    external_number: Optional[str] = None
    modified_since: Optional[datetime.datetime] = None
    all_versions: Optional[bool] = None
    archived: Optional[bool] = None
    filter_name: Optional[str] = None
    prog_code: Optional[str] = None
    registration_profile_field_i_d: Optional[str] = None
    dependable_fields: Optional[List[RegistrationProfileFieldValue]] = None

Python 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