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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetDocumentsCount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <AllVersions>false</AllVersions>
  <Archived>false</Archived>
  <DependableFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationProfileFieldValue>
      <d2p1:DocumentFieldID>00000000-0000-0000-0000-000000000000</d2p1:DocumentFieldID>
      <d2p1:IsModifiedByUser>false</d2p1:IsModifiedByUser>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationProfileFieldValue>
  </DependableFields>
  <ExplorerID>00000000-0000-0000-0000-000000000000</ExplorerID>
  <ExternalNumber>String</ExternalNumber>
  <FilterName>String</FilterName>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <Path>String</Path>
  <ProgCode>String</ProgCode>
  <RegistrationProfileFieldID>00000000-0000-0000-0000-000000000000</RegistrationProfileFieldID>
  <SearchCriteria>String</SearchCriteria>
  <ViewID>00000000-0000-0000-0000-000000000000</ViewID>
</GetDocumentsCount>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>