ClubReady Api

<back to all web services

GetClassScheduleRequest

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.

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

        '''<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.")>
        Public Partial Class GetClassScheduleRequest
            Inherits GetClassScheduleRequestDto
            Implements IRestrictedApiRequest
            '''<Summary>
            '''Api Key - grants access to resources
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''StoreID
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreID", IsRequired:=true, Name:="StoreID", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<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")>
            Public Overridable Property FromDate As Nullable(Of Date)

            '''<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")>
            Public Overridable Property ToDate As Nullable(Of Date)

            '''<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")>
            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 GetClassScheduleRequest DTOs

GET /scheduling/class-schedule HTTP/1.1 
Host: clubready.com 
Accept: application/xml