| GET | /scheduling/class-category | Retrieve a list of Class Categories available to a store or chain |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Scheduling.Model;
using ClubReady.Core.Scheduling.Models.Dto.Requests;
using ClubReady.Web.Api;
namespace ClubReady.Core.Scheduling.Models.Dto.Requests
{
public partial class ClassCategoryRequestDto
{
public virtual int? StoreId { get; set; }
public virtual int? ChainId { get; set; }
}
}
namespace ClubReady.Web.Api
{
public enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
}
namespace ClubReady.Web.Api.Scheduling.Model
{
public partial class ClassCategoriesRequest
: ClassCategoryRequestDto, 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 virtual string ApiKey { get; set; }
///<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 virtual int? StoreId { get; set; }
///<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 virtual int? ChainId { get; set; }
public virtual int? RestrictedId { get; set; }
public virtual RestrictedResourceType RestrictedResourceType { get; set; }
}
}
C# ClassCategoriesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv