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.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class GetFile implements JsonSerializable
{
    public function __construct(
        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $Id='',

        /** @description 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.")
        /** @var bool|null */
        public ?bool $Stream=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Stream'])) $this->Stream = $o['Stream'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Stream)) $o['Stream'] = $this->Stream;
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetFile 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 /file HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/json