| GET | /uplift/history |
|---|
<?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 ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo, JsonSerializable
{
public function __construct(
/** @description The API Key required for authentication */
// @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
/** @var string */
public string $apiKey='',
/** @description Latitude of the user making this request */
// @ApiMember(DataType="double", Description="Latitude of the user making this request")
/** @var float */
public float $latitude=0.0,
/** @description Longitude of the user making this request */
// @ApiMember(DataType="double", Description="Longitude of the user making this request")
/** @var float */
public float $longitude=0.0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['apiKey'])) $this->apiKey = $o['apiKey'];
if (isset($o['latitude'])) $this->latitude = $o['latitude'];
if (isset($o['longitude'])) $this->longitude = $o['longitude'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->apiKey)) $o['apiKey'] = $this->apiKey;
if (isset($this->latitude)) $o['latitude'] = $this->latitude;
if (isset($this->longitude)) $o['longitude'] = $this->longitude;
return empty($o) ? new class(){} : $o;
}
}
class ApiServiceResponse implements IServiceResponse, JsonSerializable
{
public function __construct(
/** @description Information about the response. */
// @ApiMember(Description="Information about the response.", IsRequired=true)
/** @var string */
public string $description='',
/** @description Heading or summary of the response. */
// @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
/** @var string */
public string $heading='',
/** @description Did the intended operation for this response complete successfully? */
// @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
/** @var bool|null */
public ?bool $wasSuccessful=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['description'])) $this->description = $o['description'];
if (isset($o['heading'])) $this->heading = $o['heading'];
if (isset($o['wasSuccessful'])) $this->wasSuccessful = $o['wasSuccessful'];
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->description)) $o['description'] = $this->description;
if (isset($this->heading)) $o['heading'] = $this->heading;
if (isset($this->wasSuccessful)) $o['wasSuccessful'] = $this->wasSuccessful;
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
class UpliftHistoryItem implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $principleLogo=null,
/** @var string|null */
public ?string $principleName=null,
/** @var string|null */
public ?string $outletName=null,
/** @var string|null */
public ?string $appointmentDate=null,
/** @var string|null */
public ?string $appointmentDateFormatted=null,
/** @var string|null */
public ?string $submittedDate=null,
/** @var string|null */
public ?string $submittedDateFormatted=null,
/** @var string|null */
public ?string $upliftNumber=null,
/** @var string|null */
public ?string $submissionDocument=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['principleLogo'])) $this->principleLogo = $o['principleLogo'];
if (isset($o['principleName'])) $this->principleName = $o['principleName'];
if (isset($o['outletName'])) $this->outletName = $o['outletName'];
if (isset($o['appointmentDate'])) $this->appointmentDate = $o['appointmentDate'];
if (isset($o['appointmentDateFormatted'])) $this->appointmentDateFormatted = $o['appointmentDateFormatted'];
if (isset($o['submittedDate'])) $this->submittedDate = $o['submittedDate'];
if (isset($o['submittedDateFormatted'])) $this->submittedDateFormatted = $o['submittedDateFormatted'];
if (isset($o['upliftNumber'])) $this->upliftNumber = $o['upliftNumber'];
if (isset($o['submissionDocument'])) $this->submissionDocument = $o['submissionDocument'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->principleLogo)) $o['principleLogo'] = $this->principleLogo;
if (isset($this->principleName)) $o['principleName'] = $this->principleName;
if (isset($this->outletName)) $o['outletName'] = $this->outletName;
if (isset($this->appointmentDate)) $o['appointmentDate'] = $this->appointmentDate;
if (isset($this->appointmentDateFormatted)) $o['appointmentDateFormatted'] = $this->appointmentDateFormatted;
if (isset($this->submittedDate)) $o['submittedDate'] = $this->submittedDate;
if (isset($this->submittedDateFormatted)) $o['submittedDateFormatted'] = $this->submittedDateFormatted;
if (isset($this->upliftNumber)) $o['upliftNumber'] = $this->upliftNumber;
if (isset($this->submissionDocument)) $o['submissionDocument'] = $this->submissionDocument;
return empty($o) ? new class(){} : $o;
}
}
class UpliftHistoryResponse extends ApiServiceResponse implements JsonSerializable
{
/**
* @param string $description
* @param string $heading
* @param bool|null $wasSuccessful
* @param ResponseStatus|null $responseStatus
*/
public function __construct(
string $description='',
string $heading='',
?bool $wasSuccessful=null,
?ResponseStatus $responseStatus=null,
/** @var array<UpliftHistoryItem>|null */
public ?array $upliftHistoryItems=null
) {
parent::__construct($description,$heading,$wasSuccessful,$responseStatus);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['upliftHistoryItems'])) $this->upliftHistoryItems = JsonConverters::fromArray('UpliftHistoryItem', $o['upliftHistoryItems']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->upliftHistoryItems)) $o['upliftHistoryItems'] = JsonConverters::toArray('UpliftHistoryItem', $this->upliftHistoryItems);
return empty($o) ? new class(){} : $o;
}
}
class UpliftHistory extends ApiServiceRequest implements JsonSerializable
{
/**
* @param string $apiKey
* @param float $latitude
* @param float $longitude
*/
public function __construct(
string $apiKey='',
float $latitude=0.0,
float $longitude=0.0
) {
parent::__construct($apiKey,$latitude,$longitude);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /uplift/history HTTP/1.1 Host: antel.api.dev.86degrees.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"upliftHistoryItems":[{}],"description":"String","heading":"String","wasSuccessful":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}