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
import Foundation
import ServiceStack

/**
* GetInstructorScheduleRequires active-e Lesson Scheduling Service
*/
// @DataContract
public class GetInstructorScheduleRequest : BaseSecureRequest
{
    // @DataMember
    public var instructorId:Int?

    // @DataMember
    public var dateFrom:Date?

    // @DataMember
    public var dateTo:Date?

    // @DataMember
    public var includeAvailability:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case instructorId
        case dateFrom
        case dateTo
        case includeAvailability
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        instructorId = try container.decodeIfPresent(Int.self, forKey: .instructorId)
        dateFrom = try container.decodeIfPresent(Date.self, forKey: .dateFrom)
        dateTo = try container.decodeIfPresent(Date.self, forKey: .dateTo)
        includeAvailability = try container.decodeIfPresent(Bool.self, forKey: .includeAvailability)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if instructorId != nil { try container.encode(instructorId, forKey: .instructorId) }
        if dateFrom != nil { try container.encode(dateFrom, forKey: .dateFrom) }
        if dateTo != nil { try container.encode(dateTo, forKey: .dateTo) }
        if includeAvailability != nil { try container.encode(includeAvailability, forKey: .includeAvailability) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

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

    required public init(){}
}

// @DataContract
public class GetInstructorScheduleResponse : BaseResponse
{
    // @DataMember
    public var instructorSchedule:[ScheduleGeneric] = []

    // @DataMember
    public var instructorTimeInfo:InstructorTimeInfo

    // @DataMember
    public var scheduleByInstructor:[ScheduleByInstructor] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case instructorSchedule
        case instructorTimeInfo
        case scheduleByInstructor
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        instructorSchedule = try container.decodeIfPresent([ScheduleGeneric].self, forKey: .instructorSchedule) ?? []
        instructorTimeInfo = try container.decodeIfPresent(InstructorTimeInfo.self, forKey: .instructorTimeInfo)
        scheduleByInstructor = try container.decodeIfPresent([ScheduleByInstructor].self, forKey: .scheduleByInstructor) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if instructorSchedule.count > 0 { try container.encode(instructorSchedule, forKey: .instructorSchedule) }
        if instructorTimeInfo != nil { try container.encode(instructorTimeInfo, forKey: .instructorTimeInfo) }
        if scheduleByInstructor.count > 0 { try container.encode(scheduleByInstructor, forKey: .scheduleByInstructor) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class ScheduleGeneric : Codable
{
    // @DataMember
    public var isAvailability:Bool

    // @DataMember
    public var location:String

    // @DataMember
    public var startTime:Date

    // @DataMember
    public var endTime:Date

    // @DataMember
    public var desc:String

    // @DataMember
    public var apptDesc:String

    // @DataMember
    public var color:String

    // @DataMember
    public var area:String

    // @DataMember
    public var virtual:Bool

    // @DataMember
    public var students:[StudentInfoScheduleGeneric] = []

    required public init(){}
}

// @DataContract
public class StudentInfoScheduleGeneric : StudentInfoGeneric
{
    // @DataMember
    public var classMemberId:Int

    // @DataMember
    public var markedPresent:Bool

    // @DataMember
    public var markedAbsent:Bool

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case classMemberId
        case markedPresent
        case markedAbsent
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        classMemberId = try container.decodeIfPresent(Int.self, forKey: .classMemberId)
        markedPresent = try container.decodeIfPresent(Bool.self, forKey: .markedPresent)
        markedAbsent = try container.decodeIfPresent(Bool.self, forKey: .markedAbsent)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if classMemberId != nil { try container.encode(classMemberId, forKey: .classMemberId) }
        if markedPresent != nil { try container.encode(markedPresent, forKey: .markedPresent) }
        if markedAbsent != nil { try container.encode(markedAbsent, forKey: .markedAbsent) }
    }
}

// @DataContract
public class StudentInfoGeneric : Codable
{
    // @DataMember
    public var studentName:String

    // @DataMember
    public var customerName:String

    // @DataMember
    public var customerNumber:String

    // @DataMember
    public var customerEmail:String

    required public init(){}
}

// @DataContract
public class InstructorTimeInfo : Codable
{
    // @DataMember
    public var startHour:Int

    // @DataMember
    public var startMinute:Int

    // @DataMember
    public var endHour:Int

    // @DataMember
    public var endMinute:Int

    // @DataMember
    public var increment:Int

    required public init(){}
}

// @DataContract
public class ScheduleByInstructor : Codable
{
    // @DataMember
    public var instructorInfo:InstructorInfo

    // @DataMember
    public var instructorSchedule:[ScheduleGeneric] = []

    // @DataMember
    public var instructorTimeInfo:InstructorTimeInfo

    required public init(){}
}

// @DataContract
public class InstructorInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var name:String

    // @DataMember
    public var email:String

    // @DataMember
    public var topic:String

    // @DataMember
    public var availabilityInfo:InstructorAvailabilityInfo

    required public init(){}
}

public class InstructorAvailabilityInfo : Codable
{
    // @DataMember
    public var sunday:Bool

    // @DataMember
    public var monday:Bool

    // @DataMember
    public var tuesday:Bool

    // @DataMember
    public var wednesday:Bool

    // @DataMember
    public var thursday:Bool

    // @DataMember
    public var friday:Bool

    // @DataMember
    public var saturday:Bool

    required public init(){}
}

Swift 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>