ClubManager.Api

FindStaff

**Requires Authentication**
Required role:	API

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

namespace ClubManager.Api.Services.Query

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ScheduleInstance() = 
        member val ScheduleId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val MondayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val MondayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val TuesdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val TuesdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val WednesdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val WednesdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val ThursdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val ThursdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val FridayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val FridayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val SaturdayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val SaturdayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val SundayFrom:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val SundayTo:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
        member val ScheduleType:Int32 = new Int32() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StaffInstance() = 
        member val StaffId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Schedule:ScheduleInstance = null with get,set
        [<References(typeof<ScheduleInstance>)>]
        member val ScheduleId:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val Deleted:Boolean = new Boolean() with get,set
        member val Demo:Boolean = new Boolean() with get,set
        member val Group:String = null with get,set
        member val Profile:String = null with get,set
        member val FirstAidTrained:Boolean = new Boolean() with get,set
        member val DBSCheck:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val InsuranceExpires:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Staff")>]
    [<AllowNullLiteral>]
    type FindStaff() = 
        inherit QueryDb<StaffInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# FindStaff 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.

POST /api/Query/Staff HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
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/csv
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-01T00:00:00.0000000","InsuranceExpires":"0001-01-01T00:00:00.0000000"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}