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.*;

public class dtos
{

    public static class GetDocumentsCount
    {
        public UUID ViewID = null;
        public Integer PageSize = null;
        public Integer PageNumber = null;
        public String SearchCriteria = null;
        public UUID ExplorerID = null;
        public String Path = null;
        public String ExternalNumber = null;
        public Date ModifiedSince = null;
        public Boolean AllVersions = null;
        public Boolean Archived = null;
        public String FilterName = null;
        public String ProgCode = null;
        public UUID RegistrationProfileFieldID = null;
        public ArrayList<RegistrationProfileFieldValue> DependableFields = null;
        
        public UUID getViewID() { return ViewID; }
        public GetDocumentsCount setViewID(UUID value) { this.ViewID = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetDocumentsCount setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetDocumentsCount setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public String getSearchCriteria() { return SearchCriteria; }
        public GetDocumentsCount setSearchCriteria(String value) { this.SearchCriteria = value; return this; }
        public UUID getExplorerID() { return ExplorerID; }
        public GetDocumentsCount setExplorerID(UUID value) { this.ExplorerID = value; return this; }
        public String getPath() { return Path; }
        public GetDocumentsCount setPath(String value) { this.Path = value; return this; }
        public String getExternalNumber() { return ExternalNumber; }
        public GetDocumentsCount setExternalNumber(String value) { this.ExternalNumber = value; return this; }
        public Date getModifiedSince() { return ModifiedSince; }
        public GetDocumentsCount setModifiedSince(Date value) { this.ModifiedSince = value; return this; }
        public Boolean isAllVersions() { return AllVersions; }
        public GetDocumentsCount setAllVersions(Boolean value) { this.AllVersions = value; return this; }
        public Boolean isArchived() { return Archived; }
        public GetDocumentsCount setArchived(Boolean value) { this.Archived = value; return this; }
        public String getFilterName() { return FilterName; }
        public GetDocumentsCount setFilterName(String value) { this.FilterName = value; return this; }
        public String getProgCode() { return ProgCode; }
        public GetDocumentsCount setProgCode(String value) { this.ProgCode = value; return this; }
        public UUID getRegistrationProfileFieldID() { return RegistrationProfileFieldID; }
        public GetDocumentsCount setRegistrationProfileFieldID(UUID value) { this.RegistrationProfileFieldID = value; return this; }
        public ArrayList<RegistrationProfileFieldValue> getDependableFields() { return DependableFields; }
        public GetDocumentsCount setDependableFields(ArrayList<RegistrationProfileFieldValue> value) { this.DependableFields = value; return this; }
    }

    public static class RegistrationProfileFieldValue
    {
        public UUID DocumentFieldID = null;
        public String Value = null;
        public String ShadowValue = null;
        public Boolean IsModifiedByUser = null;
        
        public UUID getDocumentFieldID() { return DocumentFieldID; }
        public RegistrationProfileFieldValue setDocumentFieldID(UUID value) { this.DocumentFieldID = value; return this; }
        public String getValue() { return Value; }
        public RegistrationProfileFieldValue setValue(String value) { this.Value = value; return this; }
        public String getShadowValue() { return ShadowValue; }
        public RegistrationProfileFieldValue setShadowValue(String value) { this.ShadowValue = value; return this; }
        public Boolean getIsModifiedByUser() { return IsModifiedByUser; }
        public RegistrationProfileFieldValue setIsModifiedByUser(Boolean value) { this.IsModifiedByUser = value; return this; }
    }

}

Java 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>