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}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    o_auth_token: Optional[str] = None
    """
    The OAuthToken token return by AeServices30
    """


    # @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    The Device ID of the Mobile Device. Not used for non-mobile devices.
    """


    # @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    An identifier for your integration
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ICSCalendarRequest(BaseRequest):
    """
    ICSCalendarRequires active-e Lesson Scheduling Service
    """

    # @ApiMember(DataType="int", Description="Instructor ID. Required unless the Instructor path parameter is sent.", Name="InstructorId", ParameterType="query")
    instructor_id: int = 0
    """
    Instructor ID. Required unless the Instructor path parameter is sent.
    """


    # @ApiMember(DataType="int", Description="Location ID. Optional.", Name="InstructorId", ParameterType="query")
    location_id: Optional[int] = None
    """
    Location ID. Optional.
    """

Python 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