| GET POST | /api/documents/{DocumentID} |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Document.Operations;
using IDB.API.DTO.Document;
namespace IDB.API.DTO.Document
{
public partial class Document
: ICustomProperties
{
public Document()
{
CustomProperties = new Dictionary<string, Object>{};
}
public virtual Guid ID { get; set; }
public virtual Guid RootDocumentID { get; set; }
public virtual Guid RegistrationprofileID { get; set; }
public virtual string Title { get; set; }
public virtual string FullTitle { get; set; }
public virtual string Number { get; set; }
public virtual string Version { get; set; }
public virtual string ExternalNumber { get; set; }
public virtual string ExternalVersion { get; set; }
public virtual string InternalNumber { get; set; }
public virtual string InternalInvoiceNumber { get; set; }
public virtual int PersonID { get; set; }
public virtual int RelationID { get; set; }
public virtual string RelationTitle { get; set; }
public virtual int ProjectID { get; set; }
public virtual string ProjectTitle { get; set; }
public virtual string Extension { get; set; }
public virtual DateTime? Date { get; set; }
public virtual int CommentsCount { get; set; }
public virtual bool HasComments { get; set; }
public virtual bool HasPreview { get; set; }
public virtual string ExtraField { get; set; }
public virtual bool IsFavorite { get; set; }
public virtual string DocumentcategoryText { get; set; }
public virtual long? FileSize { get; set; }
public virtual DateTime? FileDate { get; set; }
public virtual string Hash { get; set; }
public virtual string HashType { get; set; }
public virtual string FileUrl { get; set; }
public virtual string StandardDocumentUrl { get; set; }
public virtual bool IsCorporateIdentity { get; set; }
public virtual string UserTitle { get; set; }
public virtual bool IsFrozen { get; set; }
public virtual int InternalCompanyID { get; set; }
public virtual string DirectUrl { get; set; }
public virtual bool AllowDigitalSigningOnlyOnPrimaryVersions { get; set; }
public virtual bool IsPrimaryVersion { get; set; }
public virtual string FileExtension { get; set; }
public virtual Dictionary<string, Object> CustomProperties { get; set; }
}
}
namespace IDB.API.DTO.Document.Operations
{
public partial class GetDocumentDetails
{
public virtual Guid DocumentID { get; set; }
public virtual bool IncludeCustomProperties { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
IncludeCustomProperties: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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-01,
CommentsCount: 0,
HasComments: False,
HasPreview: False,
ExtraField: String,
IsFavorite: False,
DocumentcategoryText: String,
FileSize: 0,
FileDate: 0001-01-01,
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: {}
}
}