GET POST | /api/documents/{DocumentID} |
---|
namespace IDB.API.DTO.Document
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type Document() =
member val ID:Guid = new Guid() with get,set
member val RootDocumentID:Guid = new Guid() with get,set
member val RegistrationprofileID:Guid = new Guid() with get,set
member val Title:String = null with get,set
member val FullTitle:String = null with get,set
member val Number:String = null with get,set
member val Version:String = null with get,set
member val ExternalNumber:String = null with get,set
member val ExternalVersion:String = null with get,set
member val InternalNumber:String = null with get,set
member val InternalInvoiceNumber:String = null with get,set
member val PersonID:Int32 = new Int32() with get,set
member val RelationID:Int32 = new Int32() with get,set
member val RelationTitle:String = null with get,set
member val ProjectID:Int32 = new Int32() with get,set
member val ProjectTitle:String = null with get,set
member val Extension:String = null with get,set
member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CommentsCount:Int32 = new Int32() with get,set
member val HasComments:Boolean = new Boolean() with get,set
member val HasPreview:Boolean = new Boolean() with get,set
member val ExtraField:String = null with get,set
member val IsFavorite:Boolean = new Boolean() with get,set
member val DocumentcategoryText:String = null with get,set
member val FileSize:Nullable<Int64> = new Nullable<Int64>() with get,set
member val FileDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Hash:String = null with get,set
member val HashType:String = null with get,set
member val FileUrl:String = null with get,set
member val StandardDocumentUrl:String = null with get,set
member val IsCorporateIdentity:Boolean = new Boolean() with get,set
member val UserTitle:String = null with get,set
member val IsFrozen:Boolean = new Boolean() with get,set
member val InternalCompanyID:Int32 = new Int32() with get,set
member val DirectUrl:String = null with get,set
member val AllowDigitalSigningOnlyOnPrimaryVersions:Boolean = new Boolean() with get,set
member val IsPrimaryVersion:Boolean = new Boolean() with get,set
member val FileExtension:String = null with get,set
member val CustomProperties:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
[<AllowNullLiteral>]
type GetDocumentDetails() =
member val DocumentID:Guid = new Guid() 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/{DocumentID} HTTP/1.1
Host: digiofficeapigateway.deltares.nl
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"DocumentID":"00000000-0000-0000-0000-000000000000","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":{}}}