DigiOffice Gateway Web Services

GetDocumentsCount

The following routes are available for this service:
GET POST	/api/documents/count

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class RegistrationProfileFieldValue implements IConvertible
{
    String? DocumentFieldID;
    String? Value;
    String? ShadowValue;
    bool? IsModifiedByUser;

    RegistrationProfileFieldValue({this.DocumentFieldID,this.Value,this.ShadowValue,this.IsModifiedByUser});
    RegistrationProfileFieldValue.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentFieldID = json['DocumentFieldID'];
        Value = json['Value'];
        ShadowValue = json['ShadowValue'];
        IsModifiedByUser = json['IsModifiedByUser'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentFieldID': DocumentFieldID,
        'Value': Value,
        'ShadowValue': ShadowValue,
        'IsModifiedByUser': IsModifiedByUser
    };

    getTypeName() => "RegistrationProfileFieldValue";
    TypeContext? context = _ctx;
}

class GetDocumentsCount implements IConvertible
{
    String? ViewID;
    int? PageSize;
    int? PageNumber;
    String? SearchCriteria;
    String? ExplorerID;
    String? Path;
    String? ExternalNumber;
    DateTime? ModifiedSince;
    bool? AllVersions;
    bool? Archived;
    String? FilterName;
    String? ProgCode;
    String? RegistrationProfileFieldID;
    List<RegistrationProfileFieldValue>? DependableFields;

    GetDocumentsCount({this.ViewID,this.PageSize,this.PageNumber,this.SearchCriteria,this.ExplorerID,this.Path,this.ExternalNumber,this.ModifiedSince,this.AllVersions,this.Archived,this.FilterName,this.ProgCode,this.RegistrationProfileFieldID,this.DependableFields});
    GetDocumentsCount.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ViewID = json['ViewID'];
        PageSize = json['PageSize'];
        PageNumber = json['PageNumber'];
        SearchCriteria = json['SearchCriteria'];
        ExplorerID = json['ExplorerID'];
        Path = json['Path'];
        ExternalNumber = json['ExternalNumber'];
        ModifiedSince = JsonConverters.fromJson(json['ModifiedSince'],'DateTime',context!);
        AllVersions = json['AllVersions'];
        Archived = json['Archived'];
        FilterName = json['FilterName'];
        ProgCode = json['ProgCode'];
        RegistrationProfileFieldID = json['RegistrationProfileFieldID'];
        DependableFields = JsonConverters.fromJson(json['DependableFields'],'List<RegistrationProfileFieldValue>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ViewID': ViewID,
        'PageSize': PageSize,
        'PageNumber': PageNumber,
        'SearchCriteria': SearchCriteria,
        'ExplorerID': ExplorerID,
        'Path': Path,
        'ExternalNumber': ExternalNumber,
        'ModifiedSince': JsonConverters.toJson(ModifiedSince,'DateTime',context!),
        'AllVersions': AllVersions,
        'Archived': Archived,
        'FilterName': FilterName,
        'ProgCode': ProgCode,
        'RegistrationProfileFieldID': RegistrationProfileFieldID,
        'DependableFields': JsonConverters.toJson(DependableFields,'List<RegistrationProfileFieldValue>',context!)
    };

    getTypeName() => "GetDocumentsCount";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'RegistrationProfileFieldValue': TypeInfo(TypeOf.Class, create:() => RegistrationProfileFieldValue()),
    'GetDocumentsCount': TypeInfo(TypeOf.Class, create:() => GetDocumentsCount()),
    'List<RegistrationProfileFieldValue>': TypeInfo(TypeOf.Class, create:() => <RegistrationProfileFieldValue>[]),
});

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