| GET POST | /api/documents/{DocumentID} |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetDocumentDetails
{
var DocumentID:UUID? = null
var IncludeCustomProperties:Boolean? = null
}
open class Document : ICustomProperties
{
var ID:UUID? = null
var RootDocumentID:UUID? = null
var RegistrationprofileID:UUID? = null
var Title:String? = null
var FullTitle:String? = null
var Number:String? = null
var Version:String? = null
var ExternalNumber:String? = null
var ExternalVersion:String? = null
var InternalNumber:String? = null
var InternalInvoiceNumber:String? = null
var PersonID:Int? = null
var RelationID:Int? = null
var RelationTitle:String? = null
var ProjectID:Int? = null
var ProjectTitle:String? = null
var Extension:String? = null
var Date:Date? = null
var CommentsCount:Int? = null
var HasComments:Boolean? = null
var HasPreview:Boolean? = null
var ExtraField:String? = null
var IsFavorite:Boolean? = null
var DocumentcategoryText:String? = null
var FileSize:Long? = null
var FileDate:Date? = null
var Hash:String? = null
var HashType:String? = null
var FileUrl:String? = null
var StandardDocumentUrl:String? = null
var IsCorporateIdentity:Boolean? = null
var UserTitle:String? = null
var IsFrozen:Boolean? = null
var InternalCompanyID:Int? = null
var DirectUrl:String? = null
var AllowDigitalSigningOnlyOnPrimaryVersions:Boolean? = null
var IsPrimaryVersion:Boolean? = null
var FileExtension:String? = null
var CustomProperties:HashMap<String,Object> = HashMap<String,Object>()
}
Kotlin GetDocumentDetails DTOs
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: {}
}
}