| GET | /api/GetSchedulingTypes |
|---|
<?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 TypeInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Desc=null,
// @DataMember
/** @var int */
public int $Length=0,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var string|null */
public ?string $RecurranceType=null,
// @DataMember
/** @var string|null */
public ?string $MembershipType=null,
// @DataMember
/** @var float */
public float $Rate=0.0,
// @DataMember
/** @var int|null */
public ?int $GroupingId=null,
// @DataMember
/** @var string|null */
public ?string $GroupingDesc=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['Length'])) $this->Length = $o['Length'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['RecurranceType'])) $this->RecurranceType = $o['RecurranceType'];
if (isset($o['MembershipType'])) $this->MembershipType = $o['MembershipType'];
if (isset($o['Rate'])) $this->Rate = $o['Rate'];
if (isset($o['GroupingId'])) $this->GroupingId = $o['GroupingId'];
if (isset($o['GroupingDesc'])) $this->GroupingDesc = $o['GroupingDesc'];
}
/** @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->Length)) $o['Length'] = $this->Length;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->RecurranceType)) $o['RecurranceType'] = $this->RecurranceType;
if (isset($this->MembershipType)) $o['MembershipType'] = $this->MembershipType;
if (isset($this->Rate)) $o['Rate'] = $this->Rate;
if (isset($this->GroupingId)) $o['GroupingId'] = $this->GroupingId;
if (isset($this->GroupingDesc)) $o['GroupingDesc'] = $this->GroupingDesc;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetSchedulingTypesResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<TypeInfo>|null */
public ?array $Types=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Types'])) $this->Types = JsonConverters::fromArray('TypeInfo', $o['Types']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Types)) $o['Types'] = JsonConverters::toArray('TypeInfo', $this->Types);
return empty($o) ? new class(){} : $o;
}
}
/** @description GetSchedulingTypesRequires active-e Lesson Scheduling Service */
// @DataContract
class GetSchedulingTypesRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description Type ID to look up. If sent, all other parameters will be ignored. */
// @DataMember
// @ApiMember(DataType="integer", Description="Type ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="TypeId", ParameterType="query")
/** @var int|null */
public ?int $TypeId=null,
/** @description If sent, only types in the sent grouping will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only types in the sent grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
/** @var int|null */
public ?int $GroupingId=null,
/** @description If sent, only types taught by the sent instructor will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only types taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
/** @var int|null */
public ?int $InstructorId=null,
/** @description If sent, only types taught at the sent location will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only types taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
/** @var int|null */
public ?int $LocationId=null,
/** @description If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.", Format="int64", Name="MembershipType", ParameterType="query")
/** @var string|null */
public ?string $MembershipType=null
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
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['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['MembershipType'])) $this->MembershipType = $o['MembershipType'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
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->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->MembershipType)) $o['MembershipType'] = $this->MembershipType;
return empty($o) ? new class(){} : $o;
}
}
PHP GetSchedulingTypesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingTypes HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSchedulingTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<Types>
<GetSchedulingTypesResponse.TypeInfo>
<Desc>String</Desc>
<GroupingDesc>String</GroupingDesc>
<GroupingId>0</GroupingId>
<Id>0</Id>
<Length>0</Length>
<MembershipType>String</MembershipType>
<Rate>0</Rate>
<RecurranceType>String</RecurranceType>
<Topic>String</Topic>
</GetSchedulingTypesResponse.TypeInfo>
</Types>
</GetSchedulingTypesResponse>