ClubReady Api

<back to all web services

StaffListRequest

The following routes are available for this service:
GET/staffGet Staff for a location
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static 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 String ApiKey = null;

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

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

        public Integer RestrictedId = null;
        public 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")
        public Boolean AvailableForScheduling = null;
        
        public String getApiKey() { return ApiKey; }
        public StaffListRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public StaffListRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getStaffType() { return StaffType; }
        public StaffListRequest setStaffType(Integer value) { this.StaffType = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public StaffListRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public StaffListRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
        public Boolean isAvailableForScheduling() { return AvailableForScheduling; }
        public StaffListRequest setAvailableForScheduling(Boolean value) { this.AvailableForScheduling = value; return this; }
    }

    public static class StaffListRequestDto extends ApiDtoBase
    {
        public Integer StaffType = null;
        
        public Integer getStaffType() { return StaffType; }
        public StaffListRequestDto setStaffType(Integer value) { this.StaffType = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java 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