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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * ICSCalendarRequires active-e Lesson Scheduling Service
    */
    @DataContract
    public static class ICSCalendarRequest extends BaseRequest
    {
        /**
        * 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 Integer InstructorId = null;

        /**
        * Location ID. Optional.
        */
        @DataMember
        @ApiMember(DataType="int", Description="Location ID. Optional.", Name="InstructorId", ParameterType="query")
        public Long LocationId = null;
        
        public Integer getInstructorId() { return InstructorId; }
        public ICSCalendarRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public ICSCalendarRequest setLocationId(Long value) { this.LocationId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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 String ApiKey = null;

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

        /**
        * 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 String DeviceId = null;

        /**
        * An identifier for your integration
        */
        @DataMember
        @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseRequest setAppId(String value) { this.AppId = value; return this; }
    }

}

Java ICSCalendarRequest DTOs

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

HTTP + OTHER

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: text/jsonl