ClubManager.Api

<back to all web services

FindFacility

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Facility
import Foundation
import ServiceStack

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Facility")
public class FindFacility : QueryDb<FacilityInstance>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class FacilityInstance : Codable
{
    public var facilityId:Int?
    public var name:String?
    public var Description:String?
    public var schedule:ScheduleInstance?
    // @References(typeof(ScheduleInstance))
    public var scheduleId:Int?

    public var colour:String?
    public var bookable:Bool?
    public var deleted:Bool?
    public var demo:Bool?
    public var group:String?

    required public init(){}
}

public class ScheduleInstance : Codable
{
    public var scheduleId:Int?
    public var name:String?
    public var Description:String?
    @TimeSpan public var mondayFrom:TimeInterval?
    @TimeSpan public var mondayTo:TimeInterval?
    @TimeSpan public var tuesdayFrom:TimeInterval?
    @TimeSpan public var tuesdayTo:TimeInterval?
    @TimeSpan public var wednesdayFrom:TimeInterval?
    @TimeSpan public var wednesdayTo:TimeInterval?
    @TimeSpan public var thursdayFrom:TimeInterval?
    @TimeSpan public var thursdayTo:TimeInterval?
    @TimeSpan public var fridayFrom:TimeInterval?
    @TimeSpan public var fridayTo:TimeInterval?
    @TimeSpan public var saturdayFrom:TimeInterval?
    @TimeSpan public var saturdayTo:TimeInterval?
    @TimeSpan public var sundayFrom:TimeInterval?
    @TimeSpan public var sundayTo:TimeInterval?
    public var scheduleType:Int?
    public var deleted:Bool?
    public var demo:Bool?

    required public init(){}
}


Swift FindFacility 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/Facility HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindFacility 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>
</FindFacility>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfFacilityInstancePEZRWkv_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:FacilityInstance>
      <d2p1:Bookable>false</d2p1:Bookable>
      <d2p1:Colour>String</d2p1:Colour>
      <d2p1:Deleted>false</d2p1:Deleted>
      <d2p1:Demo>false</d2p1:Demo>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FacilityId>0</d2p1:FacilityId>
      <d2p1:Group>String</d2p1:Group>
      <d2p1:Name>String</d2p1:Name>
      <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:FacilityInstance>
  </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>
</QueryResponseOfFacilityInstancePEZRWkv_P>