DigiOffice Gateway Web Services

<back to all web services

UpdateDocumentRegistration

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

public class dtos
{

    public static class UpdateDocumentRegistration
    {
        public UUID DocumentID = null;
        public ArrayList<RegistrationValue> Values = null;
        public ArrayList<Process> Processes = null;
        public Boolean GenerateOoxml = null;
        
        public UUID getDocumentID() { return DocumentID; }
        public UpdateDocumentRegistration setDocumentID(UUID value) { this.DocumentID = value; return this; }
        public ArrayList<RegistrationValue> getValues() { return Values; }
        public UpdateDocumentRegistration setValues(ArrayList<RegistrationValue> value) { this.Values = value; return this; }
        public ArrayList<Process> getProcesses() { return Processes; }
        public UpdateDocumentRegistration setProcesses(ArrayList<Process> value) { this.Processes = value; return this; }
        public Boolean isGenerateOoxml() { return GenerateOoxml; }
        public UpdateDocumentRegistration setGenerateOoxml(Boolean value) { this.GenerateOoxml = 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 RegisterDocumentResponse
    {
        public Boolean IsSucces = null;
        public UUID DocumentId = null;
        public ArrayList<String> ErrorMessages = null;
        public String Ooxml = null;
        /**
        * Is it a corporate identity document?
        */
        @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
        public Boolean IsCorporateIdentity = null;

        public HashMap<String,String> DocumentVariables = null;
        
        public Boolean getIsSucces() { return IsSucces; }
        public RegisterDocumentResponse setIsSucces(Boolean value) { this.IsSucces = value; return this; }
        public UUID getDocumentId() { return DocumentId; }
        public RegisterDocumentResponse setDocumentId(UUID value) { this.DocumentId = value; return this; }
        public ArrayList<String> getErrorMessages() { return ErrorMessages; }
        public RegisterDocumentResponse setErrorMessages(ArrayList<String> value) { this.ErrorMessages = value; return this; }
        public String getOoxml() { return Ooxml; }
        public RegisterDocumentResponse setOoxml(String value) { this.Ooxml = value; return this; }
        public Boolean getIsCorporateIdentity() { return IsCorporateIdentity; }
        public RegisterDocumentResponse setIsCorporateIdentity(Boolean value) { this.IsCorporateIdentity = value; return this; }
        public HashMap<String,String> getDocumentVariables() { return DocumentVariables; }
        public RegisterDocumentResponse setDocumentVariables(HashMap<String,String> value) { this.DocumentVariables = value; return this; }
    }

}

Java UpdateDocumentRegistration 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 /xml/reply/UpdateDocumentRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateDocumentRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <GenerateOoxml>false</GenerateOoxml>
  <Processes xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
    <d2p1:Process>
      <d2p1:Coordinator>String</d2p1:Coordinator>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ID>0</d2p1:ID>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Transitions>
        <d2p1:Transition>
          <d2p1:DelayDate>0001-01-01T00:00:00</d2p1:DelayDate>
          <d2p1:DelayReason>String</d2p1:DelayReason>
          <d2p1:GroupIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:GroupIDs>
          <d2p1:ID>00000000-0000-0000-0000-000000000000</d2p1:ID>
          <d2p1:Reason>String</d2p1:Reason>
          <d2p1:UserIDs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:int>0</d6p1:int>
          </d2p1:UserIDs>
        </d2p1:Transition>
      </d2p1:Transitions>
      <d2p1:Urgent>false</d2p1:Urgent>
    </d2p1:Process>
  </Processes>
  <Values xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Registrationprofile">
    <d2p1:RegistrationValue>
      <d2p1:Key>00000000-0000-0000-0000-000000000000</d2p1:Key>
      <d2p1:ShadowValue>String</d2p1:ShadowValue>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:RegistrationValue>
  </Values>
</UpdateDocumentRegistration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegisterDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <DocumentVariables xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ErrorMessages>
  <IsCorporateIdentity>false</IsCorporateIdentity>
  <IsSucces>false</IsSucces>
  <Ooxml>String</Ooxml>
</RegisterDocumentResponse>