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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Registrationprofile;

namespace IDB.API.DTO.Document.Operations
{
    public partial class GetDocumentsCount
    {
        public GetDocumentsCount()
        {
            DependableFields = new List<RegistrationProfileFieldValue>{};
        }

        public virtual Guid? ViewID { get; set; }
        public virtual int PageSize { get; set; }
        public virtual int PageNumber { get; set; }
        public virtual string SearchCriteria { get; set; }
        public virtual Guid? ExplorerID { get; set; }
        public virtual string Path { get; set; }
        public virtual string ExternalNumber { get; set; }
        public virtual DateTime? ModifiedSince { get; set; }
        public virtual bool AllVersions { get; set; }
        public virtual bool? Archived { get; set; }
        public virtual string FilterName { get; set; }
        public virtual string ProgCode { get; set; }
        public virtual Guid RegistrationProfileFieldID { get; set; }
        public virtual List<RegistrationProfileFieldValue> DependableFields { get; set; }
    }

}

namespace IDB.API.DTO.Registrationprofile
{
    public partial class RegistrationProfileFieldValue
    {
        public virtual Guid DocumentFieldID { get; set; }
        public virtual string Value { get; set; }
        public virtual string ShadowValue { get; set; }
        public virtual bool IsModifiedByUser { get; set; }
    }

}

C# 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: digiofficeapigateway.deltares.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