AIM Web Services

<back to all web services

GetSchedulingLocationsRequest

GetSchedulingLocations
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/GetSchedulingLocations
import Foundation
import ServiceStack

/**
* GetSchedulingLocationsRequires active-e Lesson Scheduling Service
*/
// @DataContract
public class GetSchedulingLocationsRequest : BaseRequest
{
    /**
    * Location lookup. If sent, all other parameters will be ignored.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Location lookup. If sent, all other parameters will be ignored.", Format="int64", Name="LocationId", ParameterType="query")
    public var locationId:Int?

    /**
    * If sent, only locations that offer this lesson type will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations that offer this lesson type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
    public var typeId:Int?

    /**
    * If sent, only locations that offer lessons of this grouping will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations that offer lessons of this grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
    public var groupingId:Int?

    /**
    * If sent, only locations where the sent instructor teaches will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, only locations where the sent instructor teaches will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
    public var instructorId:Int?

    // @DataMember
    public var includeInactiveLocations:Bool

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

    private enum CodingKeys : String, CodingKey {
        case locationId
        case typeId
        case groupingId
        case instructorId
        case includeInactiveLocations
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        locationId = try container.decodeIfPresent(Int.self, forKey: .locationId)
        typeId = try container.decodeIfPresent(Int.self, forKey: .typeId)
        groupingId = try container.decodeIfPresent(Int.self, forKey: .groupingId)
        instructorId = try container.decodeIfPresent(Int.self, forKey: .instructorId)
        includeInactiveLocations = try container.decodeIfPresent(Bool.self, forKey: .includeInactiveLocations)
    }

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

// @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 GetSchedulingLocationsResponse : BaseResponse
{
    // @DataMember
    public var locations:[LocationInfo] = []

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

    private enum CodingKeys : String, CodingKey {
        case locations
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        locations = try container.decodeIfPresent([LocationInfo].self, forKey: .locations) ?? []
    }

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

// @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 LocationInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var desc:String

    // @DataMember
    public var shortDesc:String

    // @DataMember
    public var region:String

    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    // @DataMember
    public var inStorePickup:String

    // @DataMember
    public var active:Bool

    // @DataMember
    public var cashSaleAcct:Int?

    required public init(){}
}

Swift GetSchedulingLocationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetSchedulingLocations HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Locations":[{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}