DigiOffice Gateway Web Services

<back to all web services

RegisterDocument

Requires Authentication
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DTO.Document.Operations
Imports IDB.API.DTO.Registrationprofile
Imports IDB.API.DTO.Workflow

Namespace Global

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class RegisterDocument
            Public Sub New()
                Values = New List(Of RegistrationValue)
                Processes = New List(Of Process)
            End Sub

            Public Overridable Property RegistrationProfileID As Guid
            Public Overridable Property Values As List(Of RegistrationValue)
            Public Overridable Property Processes As List(Of Process)
            Public Overridable Property DocumentUploadId As String
            Public Overridable Property DocumentId As Nullable(Of Guid)
            Public Overridable Property StandardDocumentID As Nullable(Of Guid)
            Public Overridable Property HasUnsavedChangesInDocument As Nullable(Of Boolean)
            Public Overridable Property IsOpenedFromNonDMSLocation As Nullable(Of Boolean)
        End Class

        Public Partial Class RegisterDocumentResponse
            Public Sub New()
                ErrorMessages = New List(Of String)
            End Sub

            Public Overridable Property IsSucces As Boolean
            Public Overridable Property DocumentId As Guid
            Public Overridable Property ErrorMessages As List(Of String)
            Public Overridable Property Ooxml As String
            '''<Summary>
            '''Is it a corporate identity document?
            '''</Summary>
            <ApiMember(Description:="Is it a corporate identity document?", IsRequired:=true)>
            Public Overridable Property IsCorporateIdentity As Boolean

            Public Overridable Property DocumentVariables As IDictionary(Of String, String)
        End Class
    End Namespace

    Namespace IDB.API.DTO.Registrationprofile

        Public Partial Class RegistrationValue
            Public Overridable Property Key As Guid
            Public Overridable Property Value As String
            Public Overridable Property ShadowValue As String
        End Class
    End Namespace

    Namespace IDB.API.DTO.Workflow

        Public Partial Class Process
            Public Sub New()
                Transitions = New List(Of Transition)
            End Sub

            Public Overridable Property ID As Integer
            Public Overridable Property Title As String
            Public Overridable Property Description As String
            Public Overridable Property Note As String
            Public Overridable Property Coordinator As String
            Public Overridable Property Urgent As Boolean
            Public Overridable Property Transitions As List(Of Transition)
        End Class

        Public Partial Class Transition
            Public Sub New()
                UserIDs = New List(Of Integer)
                GroupIDs = New List(Of Integer)
            End Sub

            Public Overridable Property ID As Guid
            Public Overridable Property Reason As String
            Public Overridable Property DelayDate As Nullable(Of Date)
            Public Overridable Property DelayReason As String
            Public Overridable Property UserIDs As List(Of Integer)
            Public Overridable Property GroupIDs As List(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET 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>