ClubManager.Api

FindStaff

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Staff

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleInstance:
    schedule_id: Optional[int] = None
    name: Optional[str] = None
    description: Optional[str] = None
    monday_from: Optional[datetime.timedelta] = None
    monday_to: Optional[datetime.timedelta] = None
    tuesday_from: Optional[datetime.timedelta] = None
    tuesday_to: Optional[datetime.timedelta] = None
    wednesday_from: Optional[datetime.timedelta] = None
    wednesday_to: Optional[datetime.timedelta] = None
    thursday_from: Optional[datetime.timedelta] = None
    thursday_to: Optional[datetime.timedelta] = None
    friday_from: Optional[datetime.timedelta] = None
    friday_to: Optional[datetime.timedelta] = None
    saturday_from: Optional[datetime.timedelta] = None
    saturday_to: Optional[datetime.timedelta] = None
    sunday_from: Optional[datetime.timedelta] = None
    sunday_to: Optional[datetime.timedelta] = None
    schedule_type: Optional[int] = None
    deleted: Optional[bool] = None
    demo: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffInstance:
    staff_id: Optional[int] = None
    name: Optional[str] = None
    schedule: Optional[ScheduleInstance] = None
    # @References(typeof(ScheduleInstance))
    schedule_id: Optional[int] = None

    deleted: Optional[bool] = None
    demo: Optional[bool] = None
    group: Optional[str] = None
    profile: Optional[str] = None
    first_aid_trained: Optional[bool] = None
    dbs_check: Optional[datetime.datetime] = None
    insurance_expires: Optional[datetime.datetime] = None


# @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Staff")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FindStaff(QueryDb[StaffInstance]):
    pass


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: Optional[int] = None
    total: Optional[int] = None
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python FindStaff 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.

POST /api/Query/Staff HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			StaffId: 0,
			Name: String,
			Schedule: 
			{
				ScheduleId: 0,
				Name: String,
				Description: String,
				MondayFrom: PT0S,
				MondayTo: PT0S,
				TuesdayFrom: PT0S,
				TuesdayTo: PT0S,
				WednesdayFrom: PT0S,
				WednesdayTo: PT0S,
				ThursdayFrom: PT0S,
				ThursdayTo: PT0S,
				FridayFrom: PT0S,
				FridayTo: PT0S,
				SaturdayFrom: PT0S,
				SaturdayTo: PT0S,
				SundayFrom: PT0S,
				SundayTo: PT0S,
				ScheduleType: 0,
				Deleted: False,
				Demo: False
			},
			ScheduleId: 0,
			Deleted: False,
			Demo: False,
			Group: String,
			Profile: String,
			FirstAidTrained: False,
			DBSCheck: 0001-01-01,
			InsuranceExpires: 0001-01-01
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}