DigiOffice Gateway Web Services

<back to all web services

AddFile

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

Namespace Global

    Namespace IDB.API.DTO.Document.Operations

        Public Partial Class AddFile
            Public Overridable Property Link As String
            Public Overridable Property BlobID As Nullable(Of Guid)
            Public Overridable Property Size As Nullable(Of Integer)
            Public Overridable Property IsAttachment As Boolean
            Public Overridable Property Data As Boolean
            Public Overridable Property OCR As Boolean
            Public Overridable Property Preview As Boolean
            Public Overridable Property Type As String
            Public Overridable Property DateTimeLastModified As Nullable(Of Date)
            Public Overridable Property MetricHeight As Nullable(Of Integer)
            Public Overridable Property MetricWidth As Nullable(Of Integer)
            Public Overridable Property DocumentID As Nullable(Of Guid)
            Public Overridable Property OriginalFileName As String
        End Class

        Public Partial Class AddFileResponse
            Public Overridable Property FileID As Guid
        End Class
    End Namespace
End Namespace

VB.NET AddFile 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/AddFile HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Link":"String","BlobID":"00000000-0000-0000-0000-000000000000","Size":0,"IsAttachment":false,"Data":false,"OCR":false,"Preview":false,"Type":"String","DateTimeLastModified":"0001-01-01T00:00:00.0000000","MetricHeight":0,"MetricWidth":0,"DocumentID":"00000000-0000-0000-0000-000000000000","OriginalFileName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FileID":"00000000-0000-0000-0000-000000000000"}