ProtocApi

<back to all web services

GetArchive

The following routes are available for this service:
All Verbs/archive/{RequestId}/{FileName}
<?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 GetArchive implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $requestId=null,
        /** @var string|null */
        public ?string $fileName=null
    ) {
    }

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

PHP GetArchive 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.

POST /archive/{RequestId}/{FileName} HTTP/1.1 
Host: grpc.servicestack.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"requestId":"String","fileName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

(byte[])