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
namespace IDB.API.DTO.Document.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RegistrationProfileFieldValue() = 
        member val DocumentFieldID:Guid = new Guid() with get,set
        member val Value:String = null with get,set
        member val ShadowValue:String = null with get,set
        member val IsModifiedByUser:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetDocumentsCount() = 
        member val ViewID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val PageSize:Int32 = new Int32() with get,set
        member val PageNumber:Int32 = new Int32() with get,set
        member val SearchCriteria:String = null with get,set
        member val ExplorerID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Path:String = null with get,set
        member val ExternalNumber:String = null with get,set
        member val ModifiedSince:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AllVersions:Boolean = new Boolean() with get,set
        member val Archived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val FilterName:String = null with get,set
        member val ProgCode:String = null with get,set
        member val RegistrationProfileFieldID:Guid = new Guid() with get,set
        member val DependableFields:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set

F# 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