DigiOffice API Services Services

GetDocumentByNumber

Get the details of a document by reference number

The following routes are available for this service:
POST	/api/documents/number

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get the details of a document by reference number
*/
@Api(Description="Get the details of a document by reference number")
open class GetDocumentByNumber
{
    open var Number:String? = null
    open var Version:String? = null
}

open class Document : ICustomProperties
{
    open var ID:UUID? = null
    open var RootDocumentID:UUID? = null
    open var RegistrationprofileID:UUID? = null
    open var Title:String? = null
    open var FullTitle:String? = null
    open var Number:String? = null
    open var Version:String? = null
    open var ExternalNumber:String? = null
    open var ExternalVersion:String? = null
    open var InternalNumber:String? = null
    open var InternalInvoiceNumber:String? = null
    open var PersonID:Int? = null
    open var RelationID:Int? = null
    open var RelationTitle:String? = null
    open var ProjectID:Int? = null
    open var ProjectTitle:String? = null
    open var Extension:String? = null
    open var Date:Date? = null
    open var CommentsCount:Int? = null
    open var HasComments:Boolean? = null
    open var HasPreview:Boolean? = null
    open var ExtraField:String? = null
    open var IsFavorite:Boolean? = null
    open var DocumentcategoryText:String? = null
    open var FileSize:Long? = null
    open var FileDate:Date? = null
    open var Hash:String? = null
    open var HashType:String? = null
    open var FileUrl:String? = null
    open var StandardDocumentUrl:String? = null
    open var IsCorporateIdentity:Boolean? = null
    open var UserTitle:String? = null
    open var IsFrozen:Boolean? = null
    open var InternalCompanyID:Int? = null
    open var InternalLocationID:Int? = null
    open var LanguageID:Int? = null
    open var DirectUrl:String? = null
    open var AllowDigitalSigningOnlyOnPrimaryVersions:Boolean? = null
    open var IsPrimaryVersion:Boolean? = null
    open var FileExtension:String? = null
    override var CustomProperties:HashMap<String,Object>? = null
}

Kotlin GetDocumentByNumber DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/documents/number HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Number: String,
	Version: String
}

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,
	InternalLocationID: 0,
	LanguageID: 0,
	DirectUrl: String,
	AllowDigitalSigningOnlyOnPrimaryVersions: False,
	IsPrimaryVersion: False,
	FileExtension: String,
	CustomProperties: 
	{
		String: {}
	}
}