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.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Scheduling.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class GetClassScheduleRequestDto
            Inherits ApiDtoBase
            Public Overridable Property FromDate As Nullable(Of Date)
            Public Overridable Property ToDate As Nullable(Of Date)
            Public Overridable Property FilterByCategoryId As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Scheduling.Model

        Public Partial Class GetClassScheduleRequestV2
            Inherits GetClassScheduleRequestDto
            Implements IRestrictedApiRequest
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property FromDate As Nullable(Of Date)
            Public Overridable Property ToDate As Nullable(Of Date)
            '''<Summary>
            ''' Id of CategoryNames to filter results by
            '''</Summary>
            <ApiMember(DataType:="integer", Description:=" Id of CategoryNames to filter results by", Name:="FilterByCategoryId", ParameterType:="query")>
            Public Overridable Property FilterByCategoryId As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class
    End Namespace
End Namespace

VB.NET 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