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 Foundation
import ServiceStack

public class GetDocumentsCount : Codable
{
    public var viewID:String?
    public var pageSize:Int?
    public var pageNumber:Int?
    public var searchCriteria:String?
    public var explorerID:String?
    public var path:String?
    public var externalNumber:String?
    public var modifiedSince:Date?
    public var allVersions:Bool?
    public var archived:Bool?
    public var filterName:String?
    public var progCode:String?
    public var registrationProfileFieldID:String?
    public var dependableFields:[RegistrationProfileFieldValue] = []

    required public init(){}
}

public class RegistrationProfileFieldValue : Codable
{
    public var documentFieldID:String?
    public var value:String?
    public var shadowValue:String?
    public var isModifiedByUser:Bool?

    required public init(){}
}


Swift 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