| GET POST | /api/documents |
|---|
Imports System
Imports System.IO
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 GetDocuments
Implements IPageOptions
Implements IModifiedSince
Implements ISearchCriteria
Public Overridable Property ViewID As Guid?
Public Overridable Property PageSize As Integer Implements IPageOptions.PageSize
Public Overridable Property PageNumber As Integer Implements IPageOptions.PageNumber
Public Overridable Property SearchCriteria As String Implements ISearchCriteria.SearchCriteria
Public Overridable Property ExplorerID As Guid?
Public Overridable Property Path As String
Public Overridable Property ExternalNumber As String
Public Overridable Property ModifiedSince As Date? Implements IModifiedSince.ModifiedSince
Public Overridable Property AllVersions As Boolean
Public Overridable Property OrderBy As String
Public Overridable Property Archived As 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)
Public Overridable Property IncludeCustomProperties As Boolean
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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/documents HTTP/1.1
Host: test-do-services.klokgroep.nl
Accept: text/jsonl
Content-Type: text/jsonl
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,"OrderBy":"String","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}],"IncludeCustomProperties":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
[{"ID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","RegistrationprofileID":"00000000-0000-0000-0000-000000000000","Title":"String","FullTitle":"String","Number":"String","Version":"String","ExternalNumber":"String","ExternalVersion":"String","InternalNumber":"String","InternalInvoiceNumber":"String","PersonID":0,"RelationID":0,"RelationTitle":"String","ProjectID":0,"ProjectTitle":"String","Extension":"String","Date":"0001-01-01T00:00:00.0000000","CommentsCount":0,"HasComments":false,"HasPreview":false,"ExtraField":"String","IsFavorite":false,"DocumentcategoryText":"String","FileSize":0,"FileDate":"0001-01-01T00:00:00.0000000","Hash":"String","HashType":"String","FileUrl":"String","StandardDocumentUrl":"String","IsCorporateIdentity":false,"UserTitle":"String","IsFrozen":false,"InternalCompanyID":0,"InternalLocationID":0,"LanguageID":0,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}]