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
namespace IDB.API.DTO.Document.Operations

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<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)>]
    [<AllowNullLiteral>]
    type GetDocumentUploadFile() = 
        ///<summary>
        ///Documentupload ID
        ///</summary>
        [<ApiMember(Description="Documentupload ID", IsRequired=true)>]
        member val ID:Int32 = new Int32() with get,set

F# 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: doapigw.baasbv.nl 
Accept: text/csv

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

(byte[])