1Fetch Client API

<back to all web services

GetFile

The following routes are available for this service:
GET/fileReturns the specified file (PDF, xlxs, doc) based on the Id.
GET/file/{id}Returns the specified file (PDF, xlxs, doc) based on the Id.
import 'package:servicestack/servicestack.dart';

class GetFile implements IConvertible
{
    // @ApiMember(IsRequired=true)
    String? Id;

    /**
    * Changes how the file is send by the server. Set to true to try and open the file in a browser without downloading.
    */
    // @ApiMember(Description="Changes how the file is send by the server. Set to true to try and open the file in a browser without downloading.")
    bool? Stream;

    GetFile({this.Id,this.Stream});
    GetFile.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'api.1fetch.co.za', types: <String, TypeInfo> {
    'GetFile': TypeInfo(TypeOf.Class, create:() => GetFile()),
});

Dart GetFile 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 /file HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/csv