| GET | /scheduling/class-schedule | Get Class Schedule | Specify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today. |
|---|---|---|---|
| GET | /v2/{Apikey}/club/{StoreID}/classschedule | (obsolete) Get Class Schedule | Specify ToDate/FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today. |
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type GetClassScheduleRequestDto() =
inherit ApiDtoBase()
member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val FilterByCategoryId:Nullable<Int32> = new Nullable<Int32>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
///<summary>
///Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.
///</summary>
[<Api(Description="Get a list of classes for a locations. Specify ToDate / FromDate (max 7 days) to get a list of classes within a date range. Omitting dates will retrieve classes for today.")>]
[<AllowNullLiteral>]
type GetClassScheduleRequest() =
inherit GetClassScheduleRequestDto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///StoreID
///</summary>
[<ApiMember(DataType="integer", Description="StoreID", IsRequired=true, Name="StoreID", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///From Date (if blank, defaults to today; format: YYYY-MM-DD)
///</summary>
[<ApiMember(DataType="date", Description="From Date (if blank, defaults to today; format: YYYY-MM-DD)", Name="FromDate", ParameterType="query")>]
member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///To Date (max 7 days; format: YYYY-MM-DD)
///</summary>
[<ApiMember(DataType="date", Description="To Date (max 7 days; format: YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")>]
member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Id of Category Names to filter results by
///</summary>
[<ApiMember(DataType="int", Description="Id of Category Names to filter results by", Name="FilterByCategoryId", ParameterType="query")>]
member val FilterByCategoryId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
F# GetClassScheduleRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /scheduling/class-schedule HTTP/1.1 Host: clubready.com Accept: text/jsv