DigiOffice Gateway Web Services

RegisterDocument

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


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

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

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

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

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

    var DocumentVariables:HashMap<String,String> = HashMap<String,String>()
}

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: digiofficeapigateway.deltares.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
}