DigiOffice Gateway Web Services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

The following routes are available for this service:
POST	/api/documentuploads/registerdocuments

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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"Documents":[{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","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: application/json
Content-Length: length

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