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
GET/api/ICSCalendar/{Instructorid}

// @DataContract
export class BaseRequest
{
    /** @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")
    public ApiKey: string;

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

    /** @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")
    public DeviceId: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

/** @description ICSCalendarRequires active-e Lesson Scheduling Service */
// @DataContract
export class ICSCalendarRequest extends BaseRequest
{
    /** @description Instructor ID. Required unless the Instructor path parameter is sent. */
    // @DataMember
    // @ApiMember(DataType="int", Description="Instructor ID. Required unless the Instructor path parameter is sent.", Name="InstructorId", ParameterType="query")
    public InstructorId: number;

    /** @description Location ID. Optional. */
    // @DataMember
    // @ApiMember(DataType="int", Description="Location ID. Optional.", Name="InstructorId", ParameterType="query")
    public LocationId?: number;

    public constructor(init?: Partial<ICSCalendarRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ICSCalendarRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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/xml