DigiOffice API Services Services

<back to all web services

RegisterDocument

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


open class RegisterDocument
{
    open var RegistrationProfileID:UUID? = null
    open var Values:ArrayList<RegistrationValue>? = null
    open var Processes:ArrayList<Process>? = null
    open var DocumentUploadId:String? = null
    open var DocumentId:UUID? = null
    open var StandardDocumentID:UUID? = null
    open var HasUnsavedChangesInDocument:Boolean? = null
    open var IsOpenedFromNonDMSLocation:Boolean? = null
}

open class RegistrationValue
{
    open var Key:UUID? = null
    open var Value:String? = null
    open var ShadowValue:String? = null
}

open class Process
{
    open var ID:Int? = null
    open var Title:String? = null
    open var Description:String? = null
    open var Note:String? = null
    open var Coordinator:String? = null
    open var Urgent:Boolean? = null
    open var Transitions:ArrayList<Transition>? = null
}

open class Transition
{
    open var ID:UUID? = null
    open var Reason:String? = null
    open var DelayDate:Date? = null
    open var DelayReason:String? = null
    open var UserIDs:ArrayList<Int>? = null
    open var GroupIDs:ArrayList<Int>? = null
}

open class RegisterDocumentResponse
{
    open var IsSucces:Boolean? = null
    open var DocumentId:UUID? = null
    open var ErrorMessages:ArrayList<String>? = null
    open var Ooxml:String? = null
    /**
    * Is it a corporate identity document?
    */
    @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
    open var IsCorporateIdentity:Boolean? = null

    open var DocumentVariables:HashMap<String,String>? = null
}

Kotlin RegisterDocument 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 /jsv/reply/RegisterDocument HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Values: 
	[
		{
			Value: String,
			ShadowValue: String
		}
	],
	Processes: 
	[
		{
			ID: 0,
			Title: String,
			Description: String,
			Note: String,
			Coordinator: String,
			Urgent: False,
			Transitions: 
			[
				{
					Reason: String,
					DelayDate: 0001-01-01,
					DelayReason: String,
					UserIDs: 
					[
						0
					],
					GroupIDs: 
					[
						0
					]
				}
			]
		}
	],
	DocumentUploadId: String,
	DocumentId: 00000000-0000-0000-0000-000000000000,
	StandardDocumentID: 00000000-0000-0000-0000-000000000000,
	HasUnsavedChangesInDocument: False,
	IsOpenedFromNonDMSLocation: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsSucces: False,
	ErrorMessages: 
	[
		String
	],
	Ooxml: String,
	IsCorporateIdentity: False
}