1Fetch Client API

GetFile

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

"use strict";
export class GetFile {
    /** @param {{Id?:string,Stream?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /**
     * @type {boolean}
     * @description Changes how the file is send by the server. Set to true to try and open the file in a browser without downloading. */
    Stream;
}

JavaScript 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