DigiOffice Gateway Web Services

<back to all web services

AddDocumentsForBackgroundRegistration

Register documents queueud for registration in background

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

        '''<Summary>
        '''Register documents queueud for registration in background
        '''</Summary>
        <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 Partial Class AddDocumentsForBackgroundRegistration
            Public Sub New()
                Documents = New List(Of RegisterDocument)
            End Sub

            '''<Summary>
            '''List of queued documents to register in background
            '''</Summary>
            <ApiMember(Description:="List of queued documents to register in background", IsRequired:=true)>
            Public Overridable Property Documents As List(Of RegisterDocument)
        End Class

        Public Partial Class AddDocumentsForBackgroundRegistrationResponse
            Public Sub New()
                RegisteredDocumentUploads = New List(Of RegisteredDocumentUpload)
            End Sub

            Public Overridable Property RegisteredDocumentUploads As List(Of RegisteredDocumentUpload)
        End Class

        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 RegisteredDocumentUpload
            Public Overridable Property DocumentUploadID As Integer
            Public Overridable Property IsSuccess As Boolean
            Public Overridable Property Message As 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 AddDocumentsForBackgroundRegistration DTOs

POST /api/documentuploads/registerdocuments HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Documents":[{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","Values":[{"Key":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String"}],"Processes":[{"ID":0,"Title":"String","Description":"String","Note":"String","Coordinator":"String","Urgent":false,"Transitions":[{"ID":"00000000-0000-0000-0000-000000000000","Reason":"String","DelayDate":"0001-01-01T00:00:00.0000000","DelayReason":"String","UserIDs":[0],"GroupIDs":[0]}]}],"DocumentUploadId":"String","DocumentId":"00000000-0000-0000-0000-000000000000","StandardDocumentID":"00000000-0000-0000-0000-000000000000","HasUnsavedChangesInDocument":false,"IsOpenedFromNonDMSLocation":false}]}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"RegisteredDocumentUploads":[{"DocumentUploadID":0,"IsSuccess":false,"Message":"String"}]}