ClubReady Api

<back to all web services

GetClassScheduleRequestV2

The following routes are available for this service:
GET/v2/{Apikey}/club/{StoreID}/classscheduleGet Class ScheduleSpecify 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 ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ApiKey:String = null with get,set
        member val StoreId: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

    [<AllowNullLiteral>]
    type GetClassScheduleRequestV2() = 
        inherit GetClassScheduleRequestDto()
        member val ApiKey:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FromDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        ///<summary>
        /// Id of CategoryNames to filter results by
        ///</summary>
        [<ApiMember(DataType="integer", Description=" Id of CategoryNames 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# GetClassScheduleRequestV2 DTOs

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

HTTP + CSV

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

GET /v2/{Apikey}/club/{StoreID}/classschedule HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv