DigiOffice Gateway Web Services

<back to all web services

AddDocumentByEmailMessageId

Requires Authentication 
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.API.DMS.Operations
Imports IDB.API.DMS
Imports IDB.Core.Diagnostics.Interfaces

Namespace Global

    Namespace IDB.API.DMS

        Public Partial Class AttachmentMailing
        End Class

        Public Partial Class Bookmark
            Public Overridable Property RemoveLastBreak As Nullable(Of Boolean)
            Public Overridable Property ReplaceOnChange As Boolean
            Public Overridable Property IsDynamic As Boolean
        End Class

        Public Enum DocInfoSilentMode
            Off
            AllowUserInteraction
            DoNotAllowUserInteraction
        End Enum

        Public Partial Class Mailings
        End Class

        <DataContract>
        Public Partial Class MetaDataField
            <DataMember>
            Public Overridable Property ID As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property DocumentVeldID As Nullable(Of Guid)

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Label As String

            <DataMember>
            Public Overridable Property Datatype As String

            <DataMember>
            Public Overridable Property PrintLabel As String

            <DataMember>
            Public Overridable Property Entity As String

            <DataMember>
            Public Overridable Property PrintValue As String

            <DataMember>
            Public Overridable Property RegistrationValue As String

            <DataMember>
            Public Overridable Property SPSiteColumnName As String

            <DataMember>
            Public Overridable Property ShadowName As String

            <DataMember>
            Public Overridable Property ShadowDatatype As String

            <DataMember>
            Public Overridable Property ShadowSPSiteColumnName As String

            <DataMember>
            Public Overridable Property ShadowSPSiteColumnRegistrationValue As String

            <DataMember>
            Public Overridable Property ShadowRegistrationValue As String

            <DataMember>
            Public Overridable Property IsKeyField As Boolean

            <DataMember>
            Public Overridable Property KopierenBijNieuweVersie As Boolean
        End Class
    End Namespace

    Namespace IDB.API.DMS.Operations

        Public Partial Class AddDocument
            Public Sub New()
                MetaData = New List(Of MetaDataField)
                AttachmentsMailings = New List(Of AttachmentMailing)
            End Sub

            Public Overridable Property RegistrationProfileID As Guid
            Public Overridable Property DocumentID As Nullable(Of Guid)
            Public Overridable Property RootDocumentID As Nullable(Of Guid)
            Public Overridable Property AssignToUserID As Nullable(Of Integer)
            Public Overridable Property AssignToGroupID As Nullable(Of Integer)
            Public Overridable Property MetaData As List(Of MetaDataField)
            Public Overridable Property Mailings As Mailings
            Public Overridable Property AttachmentsMailings As List(Of AttachmentMailing)
            Public Overridable Property FileID As Nullable(Of Guid)
            Public Overridable Property SilentMode As DocInfoSilentMode
            Public Overridable Property updateStorageSystem As Boolean
            Public Overridable Property MessageQueueId As Nullable(Of Integer)
        End Class

        Public Partial Class AddDocumentByEmailMessageId
            Public Overridable Property ItemId As String
            Public Overridable Property EwsUrl As String
            Public Overridable Property Token As String
            Public Overridable Property DocumentId As String
            Public Overridable Property documentToAdd As AddDocument
        End Class

        Public Partial Class DocumentResponse
            Public Sub New()
                MetaData = New List(Of MetaDataField)
                Bookmarks = New List(Of Bookmark)
                AttachmentsMailings = New List(Of AttachmentMailing)
            End Sub

            Public Overridable Property DocumentID As Guid
            Public Overridable Property DocumentNr As String
            Public Overridable Property RootDocumentID As Guid
            Public Overridable Property MetaData As List(Of MetaDataField)
            Public Overridable Property Bookmarks As List(Of Bookmark)
            Public Overridable Property Mailings As Mailings
            Public Overridable Property AttachmentsMailings As List(Of AttachmentMailing)
            Public Overridable Property Messages As IInformationMessages
            Public Overridable Property SourceDocumentPath As String
            Public Overridable Property DestinationDocumentPath As String
            Public Overridable Property SharePointContentTypeName As String
            Public Overridable Property ZIPAttachments As Boolean
        End Class
    End Namespace

    Namespace IDB.Core.Diagnostics.Interfaces

        Public Interface IInformationMessages
        End Interface
    End Namespace
End Namespace

VB.NET AddDocumentByEmailMessageId DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/AddDocumentByEmailMessageId HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ItemId":"String","EwsUrl":"String","Token":"String","DocumentId":"String","documentToAdd":{"RegistrationProfileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","RootDocumentID":"00000000-0000-0000-0000-000000000000","AssignToUserID":0,"AssignToGroupID":0,"MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Mailings":{},"AttachmentsMailings":[{}],"FileID":"00000000-0000-0000-0000-000000000000","SilentMode":"Off","updateStorageSystem":false,"MessageQueueId":0}}

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

{"DocumentID":"00000000-0000-0000-0000-000000000000","DocumentNr":"String","RootDocumentID":"00000000-0000-0000-0000-000000000000","MetaData":[{"ID":"00000000-0000-0000-0000-000000000000","DocumentVeldID":"00000000-0000-0000-0000-000000000000","Name":"String","Label":"String","Datatype":"String","PrintLabel":"String","Entity":"String","PrintValue":"String","RegistrationValue":"String","SPSiteColumnName":"String","ShadowName":"String","ShadowDatatype":"String","ShadowSPSiteColumnName":"String","ShadowSPSiteColumnRegistrationValue":"String","ShadowRegistrationValue":"String","IsKeyField":false,"KopierenBijNieuweVersie":false}],"Bookmarks":[{"RemoveLastBreak":false,"ReplaceOnChange":false,"IsDynamic":false}],"Mailings":{},"AttachmentsMailings":[{}],"Messages":null,"SourceDocumentPath":"String","DestinationDocumentPath":"String","SharePointContentTypeName":"String","ZIPAttachments":false}