| GET | /api/GetSchedulingLocations |
|---|
<?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};
// @DataContract
class BaseRequest implements JsonSerializable
{
public function __construct(
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
/** @var string */
public string $ApiKey='',
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
/** @var string|null */
public ?string $OAuthToken=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponseResult implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
/** @var string|null */
public ?string $StatusCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
/** @var string|null */
public ?string $Login=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
/** @var string|null */
public ?string $ErrorCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
/** @var string|null */
public ?string $ErrorDisplayText=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
/** @var string|null */
public ?string $ErrorMessage=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
/** @var string|null */
public ?string $DomainName=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
/** @var string|null */
public ?string $IpAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['Login'])) $this->Login = $o['Login'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->Login)) $o['Login'] = $this->Login;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponse implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
/** @var BaseResponseResult|null */
public ?BaseResponseResult $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class LocationInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var string|null */
public ?string $ShortDesc=null,
// @DataMember
/** @var string|null */
public ?string $Region=null,
// @DataMember
/** @var float */
public float $Latitude=0.0,
// @DataMember
/** @var float */
public float $Longitude=0.0,
// @DataMember
/** @var string|null */
public ?string $InStorePickup=null,
// @DataMember
/** @var bool|null */
public ?bool $Active=null,
// @DataMember
/** @var int|null */
public ?int $CashSaleAcct=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Desc'])) $this->Desc = $o['Desc'];
if (isset($o['ShortDesc'])) $this->ShortDesc = $o['ShortDesc'];
if (isset($o['Region'])) $this->Region = $o['Region'];
if (isset($o['Latitude'])) $this->Latitude = $o['Latitude'];
if (isset($o['Longitude'])) $this->Longitude = $o['Longitude'];
if (isset($o['InStorePickup'])) $this->InStorePickup = $o['InStorePickup'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['CashSaleAcct'])) $this->CashSaleAcct = $o['CashSaleAcct'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Desc)) $o['Desc'] = $this->Desc;
if (isset($this->ShortDesc)) $o['ShortDesc'] = $this->ShortDesc;
if (isset($this->Region)) $o['Region'] = $this->Region;
if (isset($this->Latitude)) $o['Latitude'] = $this->Latitude;
if (isset($this->Longitude)) $o['Longitude'] = $this->Longitude;
if (isset($this->InStorePickup)) $o['InStorePickup'] = $this->InStorePickup;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->CashSaleAcct)) $o['CashSaleAcct'] = $this->CashSaleAcct;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetSchedulingLocationsResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<LocationInfo>|null */
public ?array $Locations=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Locations'])) $this->Locations = JsonConverters::fromArray('LocationInfo', $o['Locations']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Locations)) $o['Locations'] = JsonConverters::toArray('LocationInfo', $this->Locations);
return empty($o) ? new class(){} : $o;
}
}
/** @description GetSchedulingLocationsRequires active-e Lesson Scheduling Service */
// @DataContract
class GetSchedulingLocationsRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description Location lookup. If sent, all other parameters will be ignored. */
// @DataMember
// @ApiMember(DataType="integer", Description="Location lookup. If sent, all other parameters will be ignored.", Format="int64", Name="LocationId", ParameterType="query")
/** @var int|null */
public ?int $LocationId=null,
/** @description If sent, only locations that offer this lesson type will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only locations that offer this lesson type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
/** @var int|null */
public ?int $TypeId=null,
/** @description If sent, only locations that offer lessons of this grouping will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only locations that offer lessons of this grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
/** @var int|null */
public ?int $GroupingId=null,
/** @description If sent, only locations where the sent instructor teaches will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only locations where the sent instructor teaches will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
/** @var int|null */
public ?int $InstructorId=null,
// @DataMember
/** @var bool|null */
public ?bool $IncludeInactiveLocations=null
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['TypeId'])) $this->TypeId = $o['TypeId'];
if (isset($o['GroupingId'])) $this->GroupingId = $o['GroupingId'];
if (isset($o['InstructorId'])) $this->InstructorId = $o['InstructorId'];
if (isset($o['IncludeInactiveLocations'])) $this->IncludeInactiveLocations = $o['IncludeInactiveLocations'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->TypeId)) $o['TypeId'] = $this->TypeId;
if (isset($this->GroupingId)) $o['GroupingId'] = $this->GroupingId;
if (isset($this->InstructorId)) $o['InstructorId'] = $this->InstructorId;
if (isset($this->IncludeInactiveLocations)) $o['IncludeInactiveLocations'] = $this->IncludeInactiveLocations;
return empty($o) ? new class(){} : $o;
}
}
PHP GetSchedulingLocationsRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingLocations HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Locations":[{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}