| GET | /scheduling/class-roster | Get booked and waitlisted users for a class. |
|---|
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.Api.Models;
using ClubReady.Web.Api;
using ClubReady.Core.Api.Models.Enums;
namespace ClubReady.Core.Api.Models
{
public partial class ApiDtoBase
{
public virtual string ApiKey { get; set; }
public virtual int? StoreId { get; set; }
public virtual int? ChainId { get; set; }
}
public partial class ApiResponseBase
{
public virtual bool Success { get; set; }
public virtual string Message { get; set; }
}
public partial class ClassRosterItem
{
public virtual int BookingId { get; set; }
public virtual int UserId { get; set; }
public virtual string FirstName { get; set; }
public virtual string LastName { get; set; }
public virtual string Email { get; set; }
public virtual string Phone { get; set; }
public virtual DateTime BookingMade { get; set; }
public virtual bool FirstTimeBooking { get; set; }
public virtual string PackageName { get; set; }
public virtual int? PackageId { get; set; }
public virtual string LeadTypeName { get; set; }
public virtual int? LeadTypeId { get; set; }
public virtual bool IsMember { get; set; }
public virtual DateTime? MemberExpiration { get; set; }
public virtual ClassRosterCreditType CreditType { get; set; }
public virtual int CreditsRemaining { get; set; }
public virtual DateTime? NextCreditExpiration { get; set; }
public virtual short? BookingStatusId { get; set; }
public virtual string BookingStatusDescription { get; set; }
}
public partial class ClassRosterRequestDto
: ApiDtoBase
{
public virtual int ClassScheduleId { get; set; }
}
public partial class ClassRosterResponseDto
: ApiResponseBase
{
public ClassRosterResponseDto()
{
ClassRoster = new List<ClassRosterItem>{};
WaitList = new List<ClassRosterItem>{};
}
public virtual List<ClassRosterItem> ClassRoster { get; set; }
public virtual List<ClassRosterItem> WaitList { get; set; }
}
}
namespace ClubReady.Core.Api.Models.Enums
{
public enum ClassRosterCreditType
{
Uninitialized = 0,
PaidCredit = 1,
FreeCredit = 2,
AmenityCredit = 3,
MembershipTypeCredit = 4,
ClassPassCredit = 5,
Error = -1,
}
}
namespace ClubReady.Web.Api
{
public enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
}
namespace ClubReady.Web.Api.Scheduling.Model
{
public partial class ClassRosterRequest
: ClassRosterRequestDto, 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="integer", 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; }
///<summary>
///Class Schedule ID
///</summary>
[ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")]
public virtual int ClassScheduleId { get; set; }
public virtual int? RestrictedId { get; set; }
public virtual RestrictedResourceType RestrictedResourceType { get; set; }
}
public partial class ClassRosterResponse
: ClassRosterResponseDto
{
public ClassRosterResponse()
{
ClassRoster = new List<ClassRosterItem>{};
WaitList = new List<ClassRosterItem>{};
}
public virtual bool Success { get; set; }
public virtual string Message { get; set; }
public virtual DateTime ClassDate { get; set; }
public virtual int FreeSpots { get; set; }
public virtual int MaxSpots { get; set; }
public virtual int TotalBooked { get; set; }
public virtual string LocationType { get; set; }
public virtual string VirtualLink { get; set; }
public virtual List<ClassRosterItem> ClassRoster { get; set; }
public virtual List<ClassRosterItem> WaitList { get; set; }
}
}
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-roster HTTP/1.1 Host: clubready.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Success":false,"Message":"String","ClassDate":"0001-01-01T00:00:00.0000000","FreeSpots":0,"MaxSpots":0,"TotalBooked":0,"LocationType":"String","VirtualLink":"String","ClassRoster":[{"BookingId":0,"UserId":0,"FirstName":"String","LastName":"String","Email":"String","Phone":"String","BookingMade":"0001-01-01T00:00:00.0000000","FirstTimeBooking":false,"PackageName":"String","PackageId":0,"LeadTypeName":"String","LeadTypeId":0,"IsMember":false,"MemberExpiration":"0001-01-01T00:00:00.0000000","CreditType":"Uninitialized","CreditsRemaining":0,"NextCreditExpiration":"0001-01-01T00:00:00.0000000","BookingStatusId":0,"BookingStatusDescription":"String"}],"WaitList":[{"BookingId":0,"UserId":0,"FirstName":"String","LastName":"String","Email":"String","Phone":"String","BookingMade":"0001-01-01T00:00:00.0000000","FirstTimeBooking":false,"PackageName":"String","PackageId":0,"LeadTypeName":"String","LeadTypeId":0,"IsMember":false,"MemberExpiration":"0001-01-01T00:00:00.0000000","CreditType":"Uninitialized","CreditsRemaining":0,"NextCreditExpiration":"0001-01-01T00:00:00.0000000","BookingStatusId":0,"BookingStatusDescription":"String"}]}