GET POST | /api/documents/count |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations
Imports IDB.API.DTO.Registrationprofile
Namespace Global
Namespace IDB.API.DTO.Document.Operations
Public Partial Class GetDocumentsCount
Public Sub New()
DependableFields = New List(Of RegistrationProfileFieldValue)
End Sub
Public Overridable Property ViewID As Nullable(Of Guid)
Public Overridable Property PageSize As Integer
Public Overridable Property PageNumber As Integer
Public Overridable Property SearchCriteria As String
Public Overridable Property ExplorerID As Nullable(Of Guid)
Public Overridable Property Path As String
Public Overridable Property ExternalNumber As String
Public Overridable Property ModifiedSince As Nullable(Of Date)
Public Overridable Property AllVersions As Boolean
Public Overridable Property Archived As Nullable(Of Boolean)
Public Overridable Property FilterName As String
Public Overridable Property ProgCode As String
Public Overridable Property RegistrationProfileFieldID As Guid
Public Overridable Property DependableFields As List(Of RegistrationProfileFieldValue)
End Class
End Namespace
Namespace IDB.API.DTO.Registrationprofile
Public Partial Class RegistrationProfileFieldValue
Public Overridable Property DocumentFieldID As Guid
Public Overridable Property Value As String
Public Overridable Property ShadowValue As String
Public Overridable Property IsModifiedByUser As Boolean
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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