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
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* 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)
class GetDocumentUploadFile implements IConvertible
{
    /**
    * Documentupload ID
    */
    // @ApiMember(Description="Documentupload ID", IsRequired=true)
    int? ID;

    GetDocumentUploadFile({this.ID});
    GetDocumentUploadFile.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID
    };

    getTypeName() => "GetDocumentUploadFile";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'GetDocumentUploadFile': TypeInfo(TypeOf.Class, create:() => GetDocumentUploadFile()),
});

Dart GetDocumentUploadFile DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

(byte[])