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 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)
    var Documents:ArrayList<RegisterDocument> = ArrayList<RegisterDocument>()
}

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 AddDocumentsForBackgroundRegistrationResponse
{
    var RegisteredDocumentUploads:ArrayList<RegisteredDocumentUpload> = ArrayList<RegisteredDocumentUpload>()
}

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

Kotlin AddDocumentsForBackgroundRegistration DTOs

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

HTTP + XML

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: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddDocumentsForBackgroundRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <Documents>
    <RegisterDocument>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <DocumentUploadId>String</DocumentUploadId>
      <HasUnsavedChangesInDocument>false</HasUnsavedChangesInDocument>
      <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
      <Processes xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
        <d4p1:Process>
          <d4p1:Coordinator>String</d4p1:Coordinator>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:ID>0</d4p1:ID>
          <d4p1:Note>String</d4p1:Note>
          <d4p1:Title>String</d4p1:Title>
          <d4p1:Transitions>
            <d4p1:Transition>
              <d4p1:DelayDate>0001-01-01T00:00:00</d4p1:DelayDate>
              <d4p1:DelayReason>String</d4p1:DelayReason>
              <d4p1:GroupIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d4p1:GroupIDs>
              <d4p1:ID>00000000-0000-0000-0000-000000000000</d4p1:ID>
              <d4p1:Reason>String</d4p1:Reason>
              <d4p1:UserIDs xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:int>0</d8p1:int>
              </d4p1:UserIDs>
            </d4p1:Transition>
          </d4p1:Transitions>
          <d4p1:Urgent>false</d4p1:Urgent>
        </d4p1:Process>
      </Processes>
      <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
      <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
      <Values xmlns:d4p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
        <d4p1:RegistrationValue>
          <d4p1:Key>00000000-0000-0000-0000-000000000000</d4p1:Key>
          <d4p1:ShadowValue>String</d4p1:ShadowValue>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:RegistrationValue>
      </Values>
    </RegisterDocument>
  </Documents>
</AddDocumentsForBackgroundRegistration>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddDocumentsForBackgroundRegistrationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <RegisteredDocumentUploads>
    <RegisteredDocumentUpload>
      <DocumentUploadID>0</DocumentUploadID>
      <IsSuccess>false</IsSuccess>
      <Message>String</Message>
    </RegisteredDocumentUpload>
  </RegisteredDocumentUploads>
</AddDocumentsForBackgroundRegistrationResponse>