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.
ClassRosterRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoStore Id or Chain Id is required
ChainIdqueryintegerNoStore Id or Chain Id is required
ClassScheduleIdqueryintegerYesClass Schedule ID
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
ClassRosterRequestDto Parameters:
NameParameterData TypeRequiredDescription
ClassScheduleIdformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
ClassRosterResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ClassDateformDateTimeNo
FreeSpotsformintNo
MaxSpotsformintNo
TotalBookedformintNo
LocationTypeformstringNo
VirtualLinkformstringNo
ClassRosterformList<ClassRosterItem>No
WaitListformList<ClassRosterItem>No
ClassRosterResponseDto Parameters:
NameParameterData TypeRequiredDescription
ClassRosterformList<ClassRosterItem>No
WaitListformList<ClassRosterItem>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ClassRosterItem Parameters:
NameParameterData TypeRequiredDescription
BookingIdformintNo
UserIdformintNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
PhoneformstringNo
BookingMadeformDateTimeNo
FirstTimeBookingformboolNo
PackageNameformstringNo
PackageIdformint?No
LeadTypeNameformstringNo
LeadTypeIdformint?No
IsMemberformboolNo
MemberExpirationformDateTime?No
CreditTypeformClassRosterCreditTypeNo
CreditsRemainingformintNo
NextCreditExpirationformDateTime?No
BookingStatusIdformshort?No
BookingStatusDescriptionformstringNo
ClassRosterCreditType Enum:
NameValue
Uninitialized0Uninitialized
PaidCredit1Paid Credit
FreeCredit2Free Credit
AmenityCredit3Amenity Credit
MembershipTypeCredit4Membership Type Credit
ClassPassCredit5ClassPass Credit
Error-1Error

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}