GET | /scheduling/class-category | Retrieve a list of Class Categories available to a store or chain |
---|
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.Scheduling.Models.Dto.Requests
Imports ClubReady.Web.Api
Namespace Global
Namespace ClubReady.Core.Scheduling.Models.Dto.Requests
Public Partial Class ClassCategoryRequestDto
Public Overridable Property StoreId As Nullable(Of Integer)
Public Overridable Property ChainId 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 ClassCategoriesRequest
Inherits ClassCategoryRequestDto
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>
'''Store Id or Chain Id is required
'''</Summary>
<ApiMember(DataType:="int", Description:="Store Id or Chain Id is required", Name:="StoreId", ParameterType:="query")>
Public Overridable Property StoreId As Nullable(Of Integer)
'''<Summary>
'''Store Id or Chain Id is required
'''</Summary>
<ApiMember(DataType:="integer", Description:="Store Id or Chain Id is required", Name:="ChainId", ParameterType:="query")>
Public Overridable Property ChainId 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 ClassCategoriesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /scheduling/class-category HTTP/1.1 Host: clubready.com Accept: application/xml