ClubManager.Api

FindStaff

**Requires Authentication**
Required role:	API

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubManager.Api.Services.Query

Namespace Global

    Namespace ClubManager.Api.Services.Query

        <AutoQueryViewer(Description:="", IconUrl:="octicon:database", Title:="Staff")>
        Public Partial Class FindStaff
            Inherits QueryDb(Of StaffInstance)
        End Class

        Public Partial Class ScheduleInstance
            Public Overridable Property ScheduleId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property MondayFrom As Nullable(Of TimeSpan)
            Public Overridable Property MondayTo As Nullable(Of TimeSpan)
            Public Overridable Property TuesdayFrom As Nullable(Of TimeSpan)
            Public Overridable Property TuesdayTo As Nullable(Of TimeSpan)
            Public Overridable Property WednesdayFrom As Nullable(Of TimeSpan)
            Public Overridable Property WednesdayTo As Nullable(Of TimeSpan)
            Public Overridable Property ThursdayFrom As Nullable(Of TimeSpan)
            Public Overridable Property ThursdayTo As Nullable(Of TimeSpan)
            Public Overridable Property FridayFrom As Nullable(Of TimeSpan)
            Public Overridable Property FridayTo As Nullable(Of TimeSpan)
            Public Overridable Property SaturdayFrom As Nullable(Of TimeSpan)
            Public Overridable Property SaturdayTo As Nullable(Of TimeSpan)
            Public Overridable Property SundayFrom As Nullable(Of TimeSpan)
            Public Overridable Property SundayTo As Nullable(Of TimeSpan)
            Public Overridable Property ScheduleType As Integer
            Public Overridable Property Deleted As Boolean
            Public Overridable Property Demo As Boolean
        End Class

        Public Partial Class StaffInstance
            Public Overridable Property StaffId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Schedule As ScheduleInstance
            <References(GetType(ScheduleInstance))>
            Public Overridable Property ScheduleId As Nullable(Of Integer)

            Public Overridable Property Deleted As Boolean
            Public Overridable Property Demo As Boolean
            Public Overridable Property Group As String
            Public Overridable Property Profile As String
            Public Overridable Property FirstAidTrained As Boolean
            Public Overridable Property DBSCheck As Nullable(Of Date)
            Public Overridable Property InsuranceExpires As Nullable(Of Date)
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET FindStaff DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FindStaff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</FindStaff>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfStaffInstancePEZRWkv_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
    <d2p1:StaffInstance>
      <d2p1:DBSCheck>0001-01-01T00:00:00</d2p1:DBSCheck>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:Demo>false</d2p1:Demo>
      <d2p1:FirstAidTrained>false</d2p1:FirstAidTrained>
      <d2p1:Group>String</d2p1:Group>
      <d2p1:InsuranceExpires>0001-01-01T00:00:00</d2p1:InsuranceExpires>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Profile>String</d2p1:Profile>
      <d2p1:Schedule>
        <d2p1:Deleted>false</d2p1:Deleted>
        <d2p1:Demo>false</d2p1:Demo>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:FridayFrom>PT0S</d2p1:FridayFrom>
        <d2p1:FridayTo>PT0S</d2p1:FridayTo>
        <d2p1:MondayFrom>PT0S</d2p1:MondayFrom>
        <d2p1:MondayTo>PT0S</d2p1:MondayTo>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:SaturdayFrom>PT0S</d2p1:SaturdayFrom>
        <d2p1:SaturdayTo>PT0S</d2p1:SaturdayTo>
        <d2p1:ScheduleId>0</d2p1:ScheduleId>
        <d2p1:ScheduleType>0</d2p1:ScheduleType>
        <d2p1:SundayFrom>PT0S</d2p1:SundayFrom>
        <d2p1:SundayTo>PT0S</d2p1:SundayTo>
        <d2p1:ThursdayFrom>PT0S</d2p1:ThursdayFrom>
        <d2p1:ThursdayTo>PT0S</d2p1:ThursdayTo>
        <d2p1:TuesdayFrom>PT0S</d2p1:TuesdayFrom>
        <d2p1:TuesdayTo>PT0S</d2p1:TuesdayTo>
        <d2p1:WednesdayFrom>PT0S</d2p1:WednesdayFrom>
        <d2p1:WednesdayTo>PT0S</d2p1:WednesdayTo>
      </d2p1:Schedule>
      <d2p1:ScheduleId>0</d2p1:ScheduleId>
      <d2p1:StaffId>0</d2p1:StaffId>
    </d2p1:StaffInstance>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfStaffInstancePEZRWkv_P>