ClubReady Api

<back to all web services

StaffListRequest

The following routes are available for this service:
GET/staffGet Staff for a location
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Members.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class StaffListRequestDto
        : ApiDtoBase
    {
        public virtual int? StaffType { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class StaffListRequest
        : StaffListRequestDto, IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///StoreId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="StoreId is required", IsRequired=true, Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///ClubReady AdminTypeId
        ///</summary>
        [ApiMember(DataType="integer", Description="ClubReady AdminTypeId", Name="StaffType", ParameterType="query")]
        public virtual int? StaffType { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
        ///<summary>
        ///Restricts results to staff that are available for scheduling
        ///</summary>
        [ApiMember(DataType="bool", Description="Restricts results to staff that are available for scheduling", Name="AvailableForScheduling", ParameterType="query")]
        public virtual bool? AvailableForScheduling { get; set; }
    }

}

C# StaffListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /staff HTTP/1.1 
Host: clubready.com 
Accept: text/jsv