ClubReady Api

<back to all web services

ClassRosterRequest

export class ApiDtoBase implements IApiDtoBase
{
    public ApiKey?: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class ClassRosterRequestDto extends ApiDtoBase
{
    public ClassScheduleId: number;

    public constructor(init?: Partial<ClassRosterRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class ClassRosterRequest extends ClassRosterRequestDto implements IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * Store Id or Chain Id is required
    */
    // @ApiMember(DataType="integer", Description="Store Id or Chain Id is required", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * Store Id or Chain Id is required
    */
    // @ApiMember(DataType="integer", Description="Store Id or Chain Id is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * Class Schedule ID
    */
    // @ApiMember(DataType="integer", Description="Class Schedule ID", IsRequired=true, Name="ClassScheduleId", ParameterType="query")
    public ClassScheduleId: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<ClassRosterRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ApiResponseBase
{
    public Success: boolean;
    public Message?: string;

    public constructor(init?: Partial<ApiResponseBase>) { (Object as any).assign(this, init); }
}

export enum ClassRosterCreditType
{
    Uninitialized = 0,
    PaidCredit = 1,
    FreeCredit = 2,
    AmenityCredit = 3,
    MembershipTypeCredit = 4,
    ClassPassCredit = 5,
    Error = -1,
}

export class ClassRosterItem
{
    public BookingId: number;
    public UserId: number;
    public FirstName: string;
    public LastName: string;
    public Email: string;
    public Phone: string;
    public BookingMade: string;
    public FirstTimeBooking: boolean;
    public PackageName: string;
    public PackageId?: number;
    public LeadTypeName: string;
    public LeadTypeId?: number;
    public IsMember: boolean;
    public MemberExpiration?: string;
    public CreditType: ClassRosterCreditType;
    public CreditsRemaining: number;
    public NextCreditExpiration?: string;
    public BookingStatusId?: number;
    public BookingStatusDescription: string;

    public constructor(init?: Partial<ClassRosterItem>) { (Object as any).assign(this, init); }
}

export class ClassRosterResponseDto extends ApiResponseBase
{
    public ClassRoster: ClassRosterItem[];
    public WaitList: ClassRosterItem[];

    public constructor(init?: Partial<ClassRosterResponseDto>) { super(init); (Object as any).assign(this, init); }
}

export class ClassRosterResponse extends ClassRosterResponseDto
{
    public Success: boolean;
    public Message: string;
    public ClassDate: string;
    public FreeSpots: number;
    public MaxSpots: number;
    public TotalBooked: number;
    public LocationType: string;
    public VirtualLink: string;
    public ClassRoster: ClassRosterItem[];
    public WaitList: ClassRosterItem[];

    public constructor(init?: Partial<ClassRosterResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ClassRosterRequest DTOs

GET /scheduling/class-roster HTTP/1.1 
Host: clubready.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	ClassDate: 0001-01-01,
	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-01,
			FirstTimeBooking: False,
			PackageName: String,
			PackageId: 0,
			LeadTypeName: String,
			LeadTypeId: 0,
			IsMember: False,
			MemberExpiration: 0001-01-01,
			CreditType: Uninitialized,
			CreditsRemaining: 0,
			NextCreditExpiration: 0001-01-01,
			BookingStatusId: 0,
			BookingStatusDescription: String
		}
	],
	WaitList: 
	[
		{
			BookingId: 0,
			UserId: 0,
			FirstName: String,
			LastName: String,
			Email: String,
			Phone: String,
			BookingMade: 0001-01-01,
			FirstTimeBooking: False,
			PackageName: String,
			PackageId: 0,
			LeadTypeName: String,
			LeadTypeId: 0,
			IsMember: False,
			MemberExpiration: 0001-01-01,
			CreditType: Uninitialized,
			CreditsRemaining: 0,
			NextCreditExpiration: 0001-01-01,
			BookingStatusId: 0,
			BookingStatusDescription: String
		}
	]
}