ClubReady Api

StaffListRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class StaffListRequest : StaffListRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * StoreId is required
    */
    @ApiMember(DataType="integer", Description="StoreId is required", IsRequired=true, Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * ClubReady AdminTypeId
    */
    @ApiMember(DataType="integer", Description="ClubReady AdminTypeId", Name="StaffType", ParameterType="query")
    var StaffType:Int? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
    /**
    * 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")
    var AvailableForScheduling:Boolean? = null
}

open class StaffListRequestDto : ApiDtoBase()
{
    var StaffType:Int? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

Kotlin 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