ClubReady Api

<back to all web services

ClassRosterRequest

The following routes are available for this service:
GET/scheduling/class-rosterGet 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.Core.Api;
using ClubReady.Web.Api;
using ClubReady.Core.Api.Models.Enums;

namespace ClubReady.Core.Api
{
    public partial class ApiDtoBase
        : IApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

}

namespace ClubReady.Core.Api.Models
{
    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>
        ///IP address of the end user
        ///</summary>
        [ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")]
        public virtual string XForwardedFor { get; set; }

        ///<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; }
    }

}

C# ClassRosterRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClassRosterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Scheduling.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <ClassRoster xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <ClassRosterItem>
      <BookingId>0</BookingId>
      <BookingMade>0001-01-01T00:00:00</BookingMade>
      <BookingStatusDescription>String</BookingStatusDescription>
      <BookingStatusId>0</BookingStatusId>
      <CreditType>Uninitialized</CreditType>
      <CreditsRemaining>0</CreditsRemaining>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <FirstTimeBooking>false</FirstTimeBooking>
      <IsMember>false</IsMember>
      <IsWaitList>false</IsWaitList>
      <LastName>String</LastName>
      <LeadTypeId>0</LeadTypeId>
      <LeadTypeName>String</LeadTypeName>
      <MemberExpiration>0001-01-01T00:00:00</MemberExpiration>
      <NextCreditExpiration>0001-01-01T00:00:00</NextCreditExpiration>
      <PackageId>0</PackageId>
      <PackageName>String</PackageName>
      <Phone>String</Phone>
      <UserId>0</UserId>
    </ClassRosterItem>
  </ClassRoster>
  <WaitList xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <ClassRosterItem>
      <BookingId>0</BookingId>
      <BookingMade>0001-01-01T00:00:00</BookingMade>
      <BookingStatusDescription>String</BookingStatusDescription>
      <BookingStatusId>0</BookingStatusId>
      <CreditType>Uninitialized</CreditType>
      <CreditsRemaining>0</CreditsRemaining>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <FirstTimeBooking>false</FirstTimeBooking>
      <IsMember>false</IsMember>
      <IsWaitList>false</IsWaitList>
      <LastName>String</LastName>
      <LeadTypeId>0</LeadTypeId>
      <LeadTypeName>String</LeadTypeName>
      <MemberExpiration>0001-01-01T00:00:00</MemberExpiration>
      <NextCreditExpiration>0001-01-01T00:00:00</NextCreditExpiration>
      <PackageId>0</PackageId>
      <PackageName>String</PackageName>
      <Phone>String</Phone>
      <UserId>0</UserId>
    </ClassRosterItem>
  </WaitList>
  <ClassDate>0001-01-01T00:00:00</ClassDate>
  <FreeSpots>0</FreeSpots>
  <LocationType>String</LocationType>
  <MaxSpots>0</MaxSpots>
  <TotalBooked>0</TotalBooked>
  <VirtualLink>String</VirtualLink>
</ClassRosterResponse>