DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

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


/**
* Register documents queueud for registration in background
*/
@Api(Description="Register documents queueud for registration in background")
@ApiResponse(Description="All queued documents are linked to a systemtask for background processing", StatusCode=200)
open class AddDocumentsForBackgroundRegistration
{
    /**
    * List of queued documents to register in background
    */
    @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
    open var Documents:ArrayList<RegisterDocument> = ArrayList<RegisterDocument>()
}

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 AddDocumentsForBackgroundRegistrationResponse
{
    open var RegisteredDocumentUploads:ArrayList<RegisteredDocumentUpload>? = null
}

open class RegisteredDocumentUpload
{
    open var DocumentUploadID:Int? = null
    open var IsSuccess:Boolean? = null
    open var Message:String? = null
}

Kotlin AddDocumentsForBackgroundRegistration DTOs

POST /api/documentuploads/registerdocuments HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Documents: 
	[
		{
			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

{
	RegisteredDocumentUploads: 
	[
		{
			DocumentUploadID: 0,
			IsSuccess: False,
			Message: String
		}
	]
}