DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

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


open class UpdateDocumentRegistration
{
    var DocumentID:UUID? = null
    var Values:ArrayList<RegistrationValue> = ArrayList<RegistrationValue>()
    var Processes:ArrayList<Process> = ArrayList<Process>()
    var GenerateOoxml: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 UpdateDocumentRegistration 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 /json/reply/UpdateDocumentRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DocumentID":"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]}]}],"GenerateOoxml":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsSucces":false,"DocumentId":"00000000-0000-0000-0000-000000000000","ErrorMessages":["String"],"Ooxml":"String","IsCorporateIdentity":false,"DocumentVariables":null}