| GET POST | /api/documents |
|---|
namespace IDB.API.DTO.Document.Operations
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type RegistrationProfileFieldValue() =
member val DocumentFieldID:Guid = new Guid() with get,set
member val Value:String = null with get,set
member val ShadowValue:String = null with get,set
member val IsModifiedByUser:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type GetDocuments() =
member val ViewID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val PageSize:Int32 = new Int32() with get,set
member val PageNumber:Int32 = new Int32() with get,set
member val SearchCriteria:String = null with get,set
member val ExplorerID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val Path:String = null with get,set
member val ExternalNumber:String = null with get,set
member val ModifiedSince:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val AllVersions:Boolean = new Boolean() with get,set
member val OrderBy:String = null with get,set
member val Archived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val FilterName:String = null with get,set
member val ProgCode:String = null with get,set
member val RegistrationProfileFieldID:Guid = new Guid() with get,set
member val DependableFields:ResizeArray<RegistrationProfileFieldValue> = new ResizeArray<RegistrationProfileFieldValue>() with get,set
member val IncludeCustomProperties:Boolean = new Boolean() with get,set
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 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,"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/csv
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,"DirectUrl":"String","AllowDigitalSigningOnlyOnPrimaryVersions":false,"IsPrimaryVersion":false,"FileExtension":"String","CustomProperties":{"String":{}}}]