| GET | /api/GetSchedulingInstructors |
|---|
<?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;
}
}
class InstructorAvailabilityInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var bool|null */
public ?bool $Sunday=null,
// @DataMember
/** @var bool|null */
public ?bool $Monday=null,
// @DataMember
/** @var bool|null */
public ?bool $Tuesday=null,
// @DataMember
/** @var bool|null */
public ?bool $Wednesday=null,
// @DataMember
/** @var bool|null */
public ?bool $Thursday=null,
// @DataMember
/** @var bool|null */
public ?bool $Friday=null,
// @DataMember
/** @var bool|null */
public ?bool $Saturday=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Sunday'])) $this->Sunday = $o['Sunday'];
if (isset($o['Monday'])) $this->Monday = $o['Monday'];
if (isset($o['Tuesday'])) $this->Tuesday = $o['Tuesday'];
if (isset($o['Wednesday'])) $this->Wednesday = $o['Wednesday'];
if (isset($o['Thursday'])) $this->Thursday = $o['Thursday'];
if (isset($o['Friday'])) $this->Friday = $o['Friday'];
if (isset($o['Saturday'])) $this->Saturday = $o['Saturday'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Sunday)) $o['Sunday'] = $this->Sunday;
if (isset($this->Monday)) $o['Monday'] = $this->Monday;
if (isset($this->Tuesday)) $o['Tuesday'] = $this->Tuesday;
if (isset($this->Wednesday)) $o['Wednesday'] = $this->Wednesday;
if (isset($this->Thursday)) $o['Thursday'] = $this->Thursday;
if (isset($this->Friday)) $o['Friday'] = $this->Friday;
if (isset($this->Saturday)) $o['Saturday'] = $this->Saturday;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class InstructorInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var int */
public int $Id=0,
// @DataMember
/** @var string|null */
public ?string $Name=null,
// @DataMember
/** @var string|null */
public ?string $Email=null,
// @DataMember
/** @var string|null */
public ?string $Topic=null,
// @DataMember
/** @var InstructorAvailabilityInfo|null */
public ?InstructorAvailabilityInfo $AvailabilityInfo=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['Topic'])) $this->Topic = $o['Topic'];
if (isset($o['AvailabilityInfo'])) $this->AvailabilityInfo = JsonConverters::from('InstructorAvailabilityInfo', $o['AvailabilityInfo']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->Topic)) $o['Topic'] = $this->Topic;
if (isset($this->AvailabilityInfo)) $o['AvailabilityInfo'] = JsonConverters::to('InstructorAvailabilityInfo', $this->AvailabilityInfo);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class GetSchedulingInstructorsResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<InstructorInfo>|null */
public ?array $Instructors=null
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Instructors'])) $this->Instructors = JsonConverters::fromArray('InstructorInfo', $o['Instructors']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Instructors)) $o['Instructors'] = JsonConverters::toArray('InstructorInfo', $this->Instructors);
return empty($o) ? new class(){} : $o;
}
}
/** @description GetSchedulingInstructorsRequires active-e Lesson Scheduling Service */
// @DataContract
class GetSchedulingInstructorsRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description Instructor ID to lookup. If sent, other parameters will be ignored. */
// @DataMember
// @ApiMember(DataType="integer", Description="Instructor ID to lookup. If sent, other parameters will be ignored.", Format="int32", Name="InstructorId", ParameterType="query")
/** @var int|null */
public ?int $InstructorId=null,
/** @description If sent, only instructors who teach lessons with the passed grouping will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
/** @var int|null */
public ?int $GroupingId=null,
/** @description If sent, only instructors who teach lessons with the passed type will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
/** @var int|null */
public ?int $TypeId=null,
/** @description If sent, only instructors who have an availability record at the passed location will be returned. */
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only instructors who have an availability record at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
/** @var int|null */
public ?int $LocationId=null,
/** @description If true, basic Availability Info will be included in the response */
// @DataMember
// @ApiMember(DataType="boolean", Description="If true, basic Availability Info will be included in the response", Name="IncludeAvailabilityInfo", ParameterType="query")
/** @var bool|null */
public ?bool $IncludeAvailabilityInfo=null
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['InstructorId'])) $this->InstructorId = $o['InstructorId'];
if (isset($o['GroupingId'])) $this->GroupingId = $o['GroupingId'];
if (isset($o['TypeId'])) $this->TypeId = $o['TypeId'];
if (isset($o['LocationId'])) $this->LocationId = $o['LocationId'];
if (isset($o['IncludeAvailabilityInfo'])) $this->IncludeAvailabilityInfo = $o['IncludeAvailabilityInfo'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->InstructorId)) $o['InstructorId'] = $this->InstructorId;
if (isset($this->GroupingId)) $o['GroupingId'] = $this->GroupingId;
if (isset($this->TypeId)) $o['TypeId'] = $this->TypeId;
if (isset($this->LocationId)) $o['LocationId'] = $this->LocationId;
if (isset($this->IncludeAvailabilityInfo)) $o['IncludeAvailabilityInfo'] = $this->IncludeAvailabilityInfo;
return empty($o) ? new class(){} : $o;
}
}
PHP GetSchedulingInstructorsRequest 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/GetSchedulingInstructors HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Instructors":[{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}