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 .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/count HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

0