ClubReady Api

ClassRosterRequest

The following routes are available for this service:
GET	/scheduling/class-roster	Get booked and waitlisted users for a class.

**ClassRosterRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	Store Id or Chain Id is required
ChainId	query	integer	No	Store Id or Chain Id is required
ClassScheduleId	query	integer	Yes	Class Schedule ID
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**ClassRosterRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
ClassScheduleId	form	int	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**ClassRosterResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
ClassDate	form	DateTime	No
FreeSpots	form	int	No
MaxSpots	form	int	No
TotalBooked	form	int	No
LocationType	form	string	No
VirtualLink	form	string	No
ClassRoster	form	List<ClassRosterItem>	No
WaitList	form	List<ClassRosterItem>	No

**ClassRosterResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
ClassRoster	form	List<ClassRosterItem>	No
WaitList	form	List<ClassRosterItem>	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**ClassRosterItem** Parameters:
Name	Parameter	Data Type	Required
BookingId	form	int	No
UserId	form	int	No
FirstName	form	string	No
LastName	form	string	No
Email	form	string	No
Phone	form	string	No
BookingMade	form	DateTime	No
FirstTimeBooking	form	bool	No
PackageName	form	string	No
PackageId	form	int?	No
LeadTypeName	form	string	No
LeadTypeId	form	int?	No
IsMember	form	bool	No
MemberExpiration	form	DateTime?	No
CreditType	form	ClassRosterCreditType	No
CreditsRemaining	form	int	No
NextCreditExpiration	form	DateTime?	No
BookingStatusId	form	short?	No
BookingStatusDescription	form	string	No

**ClassRosterCreditType** Enum:
Name	Value
Uninitialized	0	Uninitialized
PaidCredit	1	Paid Credit
FreeCredit	2	Free Credit
AmenityCredit	3	Amenity Credit
MembershipTypeCredit	4	Membership Type Credit
ClassPassCredit	5	ClassPass Credit
Error	-1	Error

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

HTTP + 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: www.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"}]}