DigiOffice Gateway Web Services

<back to all web services

RegisterDocument

Requires Authentication
import Foundation
import ServiceStack

public class RegisterDocument : Codable
{
    public var registrationProfileID:String?
    public var values:[RegistrationValue] = []
    public var processes:[Process] = []
    public var documentUploadId:String?
    public var documentId:String?
    public var standardDocumentID:String?
    public var hasUnsavedChangesInDocument:Bool?
    public var isOpenedFromNonDMSLocation:Bool?

    required public init(){}
}

public class RegistrationValue : Codable
{
    public var key:String?
    public var value:String?
    public var shadowValue:String?

    required public init(){}
}

public class Process : Codable
{
    public var id:Int?
    public var title:String?
    public var Description:String?
    public var note:String?
    public var coordinator:String?
    public var urgent:Bool?
    public var transitions:[Transition] = []

    required public init(){}
}

public class Transition : Codable
{
    public var id:String?
    public var reason:String?
    public var delayDate:Date?
    public var delayReason:String?
    public var userIDs:[Int] = []
    public var groupIDs:[Int] = []

    required public init(){}
}

public class RegisterDocumentResponse : Codable
{
    public var isSucces:Bool?
    public var documentId:String?
    public var errorMessages:[String] = []
    public var ooxml:String?
    /**
    * Is it a corporate identity document?
    */
    // @ApiMember(Description="Is it a corporate identity document?", IsRequired=true)
    public var isCorporateIdentity:Bool?

    public var documentVariables:[String:String] = [:]

    required public init(){}
}


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

<RegisterDocument 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>
  <DocumentUploadId>String</DocumentUploadId>
  <HasUnsavedChangesInDocument>false</HasUnsavedChangesInDocument>
  <IsOpenedFromNonDMSLocation>false</IsOpenedFromNonDMSLocation>
  <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>
  <RegistrationProfileID>00000000-0000-0000-0000-000000000000</RegistrationProfileID>
  <StandardDocumentID>00000000-0000-0000-0000-000000000000</StandardDocumentID>
  <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>
</RegisterDocument>
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>