AIM Web Services

<back to all web services

ICSCalendarRequest

ICSCalendar
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/ICSCalendar
<?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='',

        /** @description The OAuthToken token return by AeServices30 */
        // @DataMember
        // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
        /** @var string */
        public string $OAuthToken='',

        /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
        // @DataMember
        // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
        /** @var string|null */
        public ?string $DeviceId=null,

        /** @description An identifier for your integration */
        // @DataMember
        // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
        /** @var string */
        public string $AppId=''
    ) {
    }

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

/** @description ICSCalendarRequires active-e Lesson Scheduling Service */
// @DataContract
class ICSCalendarRequest extends BaseRequest implements JsonSerializable
{
    /**
     * @param string $ApiKey
     * @param string $OAuthToken
     * @param string|null $DeviceId
     * @param string $AppId
     */
    public function __construct(
        string $ApiKey='',
        string $OAuthToken='',
        ?string $DeviceId=null,
        string $AppId='',
        // @DataMember
        /** @var int */
        public int $InstructorId=0,

        // @DataMember
        /** @var int */
        public int $LocationId=0
    ) {
        parent::__construct($ApiKey,$OAuthToken,$DeviceId,$AppId);
    }

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

PHP ICSCalendarRequest 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ICSCalendar HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json