POST | /scheduling/class-schedule | Create a Class Schedule |
---|
export class ApiDtoBase
{
public ApiKey: string;
public StoreId?: number;
public ChainId?: number;
public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}
export class CreateClassScheduleRequestDto extends ApiDtoBase
{
public ClassId: number;
public ClassDateTime: string;
public TrainerId?: number;
public AlternateClassName: string;
public constructor(init?: Partial<CreateClassScheduleRequestDto>) { super(init); (Object as any).assign(this, init); }
}
export enum RestrictedResourceType
{
Store = 'Store',
Chain = 'Chain',
User = 'User',
Undefined = 'Undefined',
}
export class CreateClassScheduleRequest extends CreateClassScheduleRequestDto implements IRestrictedApiRequest
{
/**
* 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
*/
// @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
public StoreId: number;
/**
* Class ID
*/
// @ApiMember(DataType="integer", Description="Class ID", IsRequired=true, Name="ClassId", ParameterType="query")
public ClassId: number;
/**
* Date and Time for Class
*/
// @ApiMember(DataType="date-time", Description="Date and Time for Class", IsRequired=true, Name="ClassDateTime", ParameterType="query")
public ClassDateTime: string;
/**
* Trainer ID
*/
// @ApiMember(DataType="integer", Description="Trainer ID", Name="TrainerId", ParameterType="query")
public TrainerId?: number;
/**
* Alternate Class Name
*/
// @ApiMember(DataType="string", Description="Alternate Class Name", Name="AlternateClassName", ParameterType="query")
public AlternateClassName: string;
public RestrictedId?: number;
public RestrictedResourceType: RestrictedResourceType;
public constructor(init?: Partial<CreateClassScheduleRequest>) { 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 class CreateClassScheduleResponseDto extends ApiResponseBase
{
public ClassScheduleId?: number;
public constructor(init?: Partial<CreateClassScheduleResponseDto>) { super(init); (Object as any).assign(this, init); }
}
export class CreateClassScheduleResponse extends CreateClassScheduleResponseDto
{
public Success: boolean;
public ClassScheduleId?: number;
public Message: string;
public constructor(init?: Partial<CreateClassScheduleResponse>) { super(init); (Object as any).assign(this, init); }
}
TypeScript CreateClassScheduleRequest DTOs
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /scheduling/class-schedule HTTP/1.1
Host: clubready.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"ApiKey":"String","StoreId":0,"ClassId":0,"ClassDateTime":"0001-01-01T00:00:00.0000000","TrainerId":0,"AlternateClassName":"String","RestrictedId":0,"RestrictedResourceType":"Store","ChainId":0}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"Success":false,"ClassScheduleId":0,"Message":"String"}