DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

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

public class dtos
{

    /**
    * 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)
    public static class AddDocumentsForBackgroundRegistration
    {
        /**
        * List of queued documents to register in background
        */
        @ApiMember(Description="List of queued documents to register in background", IsRequired=true)
        public ArrayList<RegisterDocument> Documents = null;
        
        public ArrayList<RegisterDocument> getDocuments() { return Documents; }
        public AddDocumentsForBackgroundRegistration setDocuments(ArrayList<RegisterDocument> value) { this.Documents = value; return this; }
    }

    public static class RegisterDocument
    {
        public UUID RegistrationProfileID = null;
        public ArrayList<RegistrationValue> Values = null;
        public ArrayList<Process> Processes = null;
        public String DocumentUploadId = null;
        public UUID DocumentId = null;
        public UUID StandardDocumentID = null;
        public Boolean HasUnsavedChangesInDocument = null;
        public Boolean IsOpenedFromNonDMSLocation = null;
        
        public UUID getRegistrationProfileID() { return RegistrationProfileID; }
        public RegisterDocument setRegistrationProfileID(UUID value) { this.RegistrationProfileID = value; return this; }
        public ArrayList<RegistrationValue> getValues() { return Values; }
        public RegisterDocument setValues(ArrayList<RegistrationValue> value) { this.Values = value; return this; }
        public ArrayList<Process> getProcesses() { return Processes; }
        public RegisterDocument setProcesses(ArrayList<Process> value) { this.Processes = value; return this; }
        public String getDocumentUploadId() { return DocumentUploadId; }
        public RegisterDocument setDocumentUploadId(String value) { this.DocumentUploadId = value; return this; }
        public UUID getDocumentId() { return DocumentId; }
        public RegisterDocument setDocumentId(UUID value) { this.DocumentId = value; return this; }
        public UUID getStandardDocumentID() { return StandardDocumentID; }
        public RegisterDocument setStandardDocumentID(UUID value) { this.StandardDocumentID = value; return this; }
        public Boolean isHasUnsavedChangesInDocument() { return HasUnsavedChangesInDocument; }
        public RegisterDocument setHasUnsavedChangesInDocument(Boolean value) { this.HasUnsavedChangesInDocument = value; return this; }
        public Boolean getIsOpenedFromNonDMSLocation() { return IsOpenedFromNonDMSLocation; }
        public RegisterDocument setIsOpenedFromNonDMSLocation(Boolean value) { this.IsOpenedFromNonDMSLocation = value; return this; }
    }

    public static class RegistrationValue
    {
        public UUID Key = null;
        public String Value = null;
        public String ShadowValue = null;
        
        public UUID getKey() { return Key; }
        public RegistrationValue setKey(UUID value) { this.Key = value; return this; }
        public String getValue() { return Value; }
        public RegistrationValue setValue(String value) { this.Value = value; return this; }
        public String getShadowValue() { return ShadowValue; }
        public RegistrationValue setShadowValue(String value) { this.ShadowValue = value; return this; }
    }

    public static class Process
    {
        public Integer ID = null;
        public String Title = null;
        public String Description = null;
        public String Note = null;
        public String Coordinator = null;
        public Boolean Urgent = null;
        public ArrayList<Transition> Transitions = null;
        
        public Integer getId() { return ID; }
        public Process setId(Integer value) { this.ID = value; return this; }
        public String getTitle() { return Title; }
        public Process setTitle(String value) { this.Title = value; return this; }
        public String getDescription() { return Description; }
        public Process setDescription(String value) { this.Description = value; return this; }
        public String getNote() { return Note; }
        public Process setNote(String value) { this.Note = value; return this; }
        public String getCoordinator() { return Coordinator; }
        public Process setCoordinator(String value) { this.Coordinator = value; return this; }
        public Boolean isUrgent() { return Urgent; }
        public Process setUrgent(Boolean value) { this.Urgent = value; return this; }
        public ArrayList<Transition> getTransitions() { return Transitions; }
        public Process setTransitions(ArrayList<Transition> value) { this.Transitions = value; return this; }
    }

    public static class Transition
    {
        public UUID ID = null;
        public String Reason = null;
        public Date DelayDate = null;
        public String DelayReason = null;
        public ArrayList<Integer> UserIDs = null;
        public ArrayList<Integer> GroupIDs = null;
        
        public UUID getId() { return ID; }
        public Transition setId(UUID value) { this.ID = value; return this; }
        public String getReason() { return Reason; }
        public Transition setReason(String value) { this.Reason = value; return this; }
        public Date getDelayDate() { return DelayDate; }
        public Transition setDelayDate(Date value) { this.DelayDate = value; return this; }
        public String getDelayReason() { return DelayReason; }
        public Transition setDelayReason(String value) { this.DelayReason = value; return this; }
        public ArrayList<Integer> getUserIDs() { return UserIDs; }
        public Transition setUserIDs(ArrayList<Integer> value) { this.UserIDs = value; return this; }
        public ArrayList<Integer> getGroupIDs() { return GroupIDs; }
        public Transition setGroupIDs(ArrayList<Integer> value) { this.GroupIDs = value; return this; }
    }

    public static class AddDocumentsForBackgroundRegistrationResponse
    {
        public ArrayList<RegisteredDocumentUpload> RegisteredDocumentUploads = null;
        
        public ArrayList<RegisteredDocumentUpload> getRegisteredDocumentUploads() { return RegisteredDocumentUploads; }
        public AddDocumentsForBackgroundRegistrationResponse setRegisteredDocumentUploads(ArrayList<RegisteredDocumentUpload> value) { this.RegisteredDocumentUploads = value; return this; }
    }

    public static class RegisteredDocumentUpload
    {
        public Integer DocumentUploadID = null;
        public Boolean IsSuccess = null;
        public String Message = null;
        
        public Integer getDocumentUploadID() { return DocumentUploadID; }
        public RegisteredDocumentUpload setDocumentUploadID(Integer value) { this.DocumentUploadID = value; return this; }
        public Boolean getIsSuccess() { return IsSuccess; }
        public RegisteredDocumentUpload setIsSuccess(Boolean value) { this.IsSuccess = value; return this; }
        public String getMessage() { return Message; }
        public RegisteredDocumentUpload setMessage(String value) { this.Message = value; return this; }
    }

}

Java AddDocumentsForBackgroundRegistration DTOs

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>