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

export class RegistrationProfileFieldValue
{
    public DocumentFieldID?: string;
    public Value?: string;
    public ShadowValue?: string;
    public IsModifiedByUser?: boolean;

    public constructor(init?: Partial<RegistrationProfileFieldValue>) { (Object as any).assign(this, init); }
}

export class GetDocumentsCount
{
    public ViewID?: string;
    public PageSize?: number;
    public PageNumber?: number;
    public SearchCriteria?: string;
    public ExplorerID?: string;
    public Path?: string;
    public ExternalNumber?: string;
    public ModifiedSince?: string;
    public AllVersions?: boolean;
    public Archived?: boolean;
    public FilterName?: string;
    public ProgCode?: string;
    public RegistrationProfileFieldID?: string;
    public DependableFields?: RegistrationProfileFieldValue[];

    public constructor(init?: Partial<GetDocumentsCount>) { (Object as any).assign(this, init); }
}

TypeScript 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