ClubReady Api

StaffListRequest

The following routes are available for this service:
GET	/staff	Get Staff for a location


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 StaffListRequestDto extends ApiDtoBase
{
    public StaffType?: number;

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

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

export class StaffListRequest extends StaffListRequestDto 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;

    /**
    * StoreId is required
    */
    // @ApiMember(DataType="integer", Description="StoreId is required", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * ClubReady AdminTypeId
    */
    // @ApiMember(DataType="integer", Description="ClubReady AdminTypeId", Name="StaffType", ParameterType="query")
    public StaffType?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;
    /**
    * Restricts results to staff that are available for scheduling
    */
    // @ApiMember(DataType="bool", Description="Restricts results to staff that are available for scheduling", Name="AvailableForScheduling", ParameterType="query")
    public AvailableForScheduling?: boolean;

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

TypeScript StaffListRequest DTOs

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 /staff HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv