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


/**
* GetSchedulingLocationsRequires active-e Lesson Scheduling Service
*/
@DataContract
open 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")
    var LocationId:Long? = null

    /**
    * 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")
    var TypeId:Long? = null

    /**
    * 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")
    var GroupingId:Long? = null

    /**
    * 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")
    var InstructorId:Int? = null

    @DataMember
    var IncludeInactiveLocations:Boolean? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetSchedulingLocationsResponse : BaseResponse()
{
    @DataMember
    var Locations:ArrayList<LocationInfo> = ArrayList<LocationInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var Region:String? = null

    @DataMember
    var Latitude:BigDecimal? = null

    @DataMember
    var Longitude:BigDecimal? = null

    @DataMember
    var InStorePickup:String? = null

    @DataMember
    var Active:Boolean? = null

    @DataMember
    var CashSaleAcct:Int? = null
}

Kotlin GetSchedulingLocationsRequest 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/GetSchedulingLocations HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingLocationsResponse 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>
  <Locations xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:LocationInfo>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CashSaleAcct>0</d2p1:CashSaleAcct>
      <d2p1:Desc>String</d2p1:Desc>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InStorePickup>String</d2p1:InStorePickup>
      <d2p1:Latitude>0</d2p1:Latitude>
      <d2p1:Longitude>0</d2p1:Longitude>
      <d2p1:Region>String</d2p1:Region>
      <d2p1:ShortDesc>String</d2p1:ShortDesc>
    </d2p1:LocationInfo>
  </Locations>
</GetSchedulingLocationsResponse>