DigiOffice Gateway Web Services

<back to all web services

GetDocumentUploadFile

Returns a byte array of the document to be registered

Requires Authentication
The following routes are available for this service:
GET/api/documentuploads/{ID}/download
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

        '''<Summary>
        '''Returns a byte array of the document to be registered
        '''</Summary>
        <Api(Description:="Returns a byte array of the document to be registered")>
        <ApiResponse(Description:="File is in the message body", StatusCode:=200)>
        <ApiResponse(Description:="Unauthorized to read or download documentupload", StatusCode:=401)>
        <ApiResponse(Description:="Documentupload not found", StatusCode:=410)>
        Public Partial Class GetDocumentUploadFile
            '''<Summary>
            '''Documentupload ID
            '''</Summary>
            <ApiMember(Description:="Documentupload ID", IsRequired:=true)>
            Public Overridable Property ID As Integer
        End Class
    End Namespace
End Namespace

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

GET /api/documentuploads/{ID}/download HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

(byte[])