| GET | /api/GetSchedulingTypes |
|---|
namespace AIM.WebService
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponseResult() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
member val StatusCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
member val Login:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
member val ErrorCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
member val ErrorDisplayText:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
member val ErrorMessage:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
member val DomainName:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
member val IpAddress:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
member val Status:BaseResponseResult = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type TypeInfo() =
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataMember>]
member val Desc:String = null with get,set
[<DataMember>]
member val Length:Int32 = new Int32() with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val RecurranceType:String = null with get,set
[<DataMember>]
member val MembershipType:String = null with get,set
[<DataMember>]
member val Rate:Decimal = new Decimal() with get,set
[<DataMember>]
member val GroupingId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember>]
member val GroupingDesc:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetSchedulingTypesResponse() =
inherit BaseResponse()
[<DataMember>]
member val Types:ResizeArray<TypeInfo> = new ResizeArray<TypeInfo>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseRequest() =
///<summary>
///This is your AIM API Key provided by Tri-Tech
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
member val ApiKey:String = null with get,set
[<DataMember>]
[<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
member val OAuthToken:String = null with get,set
///<summary>
///GetSchedulingTypesRequires active-e Lesson Scheduling Service
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type GetSchedulingTypesRequest() =
inherit BaseRequest()
///<summary>
///Type ID to look up. If sent, all other parameters will be ignored.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="Type ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="TypeId", ParameterType="query")>]
member val TypeId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///If sent, only types in the sent grouping will be returned.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="If sent, only types in the sent grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")>]
member val GroupingId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///If sent, only types taught by the sent instructor will be returned.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="If sent, only types taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")>]
member val InstructorId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///If sent, only types taught at the sent location will be returned.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="If sent, only types taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")>]
member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.", Format="int64", Name="MembershipType", ParameterType="query")>]
member val MembershipType:String = null with get,set
F# GetSchedulingTypesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingTypes HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Types":[{"Id":0,"Desc":"String","Length":0,"Topic":"String","RecurranceType":"String","MembershipType":"String","Rate":0,"GroupingId":0,"GroupingDesc":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}