ClubReady Api

StaffListRequest

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class StaffListRequestDto
            Inherits ApiDtoBase
            Public Overridable Property StaffType As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class StaffListRequest
            Inherits StaffListRequestDto
            Implements 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 Overridable Property ApiKey As String

            '''<Summary>
            '''StoreId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreId is required", IsRequired:=true, Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''ClubReady AdminTypeId
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="ClubReady AdminTypeId", Name:="StaffType", ParameterType:="query")>
            Public Overridable Property StaffType As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
            '''<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 Overridable Property AvailableForScheduling As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET 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