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

/**
* Returns a byte array of the document to be registered
*/
// @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)
export class GetDocumentUploadFile
{
    /**
    * Documentupload ID
    */
    // @ApiMember(Description="Documentupload ID", IsRequired=true)
    public ID: number;

    public constructor(init?: Partial<GetDocumentUploadFile>) { (Object as any).assign(this, init); }
}

TypeScript 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[])