AIM Web Services

<back to all web services

GetInstructorScheduleRequest

GetInstructorSchedule
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST, GET/api/GetInstructorSchedule

// @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;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

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

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

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

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

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

// @DataContract
export class StudentInfoGeneric
{
    // @DataMember
    public StudentName: string;

    // @DataMember
    public CustomerName: string;

    // @DataMember
    public CustomerNumber: string;

    // @DataMember
    public CustomerEmail: string;

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

// @DataContract
export class StudentInfoScheduleGeneric extends StudentInfoGeneric
{
    // @DataMember
    public ClassMemberId: number;

    // @DataMember
    public MarkedPresent: boolean;

    // @DataMember
    public MarkedAbsent: boolean;

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

// @DataContract
export class ScheduleGeneric
{
    // @DataMember
    public IsAvailability: boolean;

    // @DataMember
    public Location: string;

    // @DataMember
    public StartTime: string;

    // @DataMember
    public EndTime: string;

    // @DataMember
    public Desc: string;

    // @DataMember
    public ApptDesc: string;

    // @DataMember
    public Color: string;

    // @DataMember
    public Area: string;

    // @DataMember
    public Virtual: boolean;

    // @DataMember
    public Students: StudentInfoScheduleGeneric[];

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

// @DataContract
export class InstructorTimeInfo
{
    // @DataMember
    public StartHour: number;

    // @DataMember
    public StartMinute: number;

    // @DataMember
    public EndHour: number;

    // @DataMember
    public EndMinute: number;

    // @DataMember
    public Increment: number;

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

export class InstructorAvailabilityInfo
{
    // @DataMember
    public Sunday: boolean;

    // @DataMember
    public Monday: boolean;

    // @DataMember
    public Tuesday: boolean;

    // @DataMember
    public Wednesday: boolean;

    // @DataMember
    public Thursday: boolean;

    // @DataMember
    public Friday: boolean;

    // @DataMember
    public Saturday: boolean;

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

// @DataContract
export class InstructorInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Name: string;

    // @DataMember
    public Email: string;

    // @DataMember
    public Topic: string;

    // @DataMember
    public AvailabilityInfo: InstructorAvailabilityInfo;

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

// @DataContract
export class ScheduleByInstructor
{
    // @DataMember
    public InstructorInfo: InstructorInfo;

    // @DataMember
    public InstructorSchedule: ScheduleGeneric[];

    // @DataMember
    public InstructorTimeInfo: InstructorTimeInfo;

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

// @DataContract
export class GetInstructorScheduleResponse extends BaseResponse
{
    // @DataMember
    public InstructorSchedule: ScheduleGeneric[];

    // @DataMember
    public InstructorTimeInfo: InstructorTimeInfo;

    // @DataMember
    public ScheduleByInstructor: ScheduleByInstructor[];

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

/** @description GetInstructorScheduleRequires active-e Lesson Scheduling Service */
// @DataContract
export class GetInstructorScheduleRequest extends BaseSecureRequest
{
    // @DataMember
    public InstructorId?: number;

    // @DataMember
    public DateFrom?: string;

    // @DataMember
    public DateTo?: string;

    // @DataMember
    public IncludeAvailability?: boolean;

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

TypeScript GetInstructorScheduleRequest 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.

POST /api/GetInstructorSchedule HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetInstructorScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <IncludeAvailability>false</IncludeAvailability>
  <InstructorId>0</InstructorId>
</GetInstructorScheduleRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInstructorScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <InstructorSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScheduleGeneric i:nil="true" />
  </InstructorSchedule>
  <InstructorTimeInfo i:nil="true" />
  <ScheduleByInstructor>
    <ScheduleByInstructor>
      <InstructorInfo>
        <AvailabilityInfo>
          <Friday>false</Friday>
          <Monday>false</Monday>
          <Saturday>false</Saturday>
          <Sunday>false</Sunday>
          <Thursday>false</Thursday>
          <Tuesday>false</Tuesday>
          <Wednesday>false</Wednesday>
        </AvailabilityInfo>
        <Email>String</Email>
        <Id>0</Id>
        <Name>String</Name>
        <Topic>String</Topic>
      </InstructorInfo>
      <InstructorSchedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:ScheduleGeneric i:nil="true" />
      </InstructorSchedule>
      <InstructorTimeInfo i:nil="true" />
    </ScheduleByInstructor>
  </ScheduleByInstructor>
</GetInstructorScheduleResponse>