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 java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Facility")
    public static class FindFacility extends QueryDb<FacilityInstance>
    {
        
    }

    public static class QueryDb<T> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        @DataMember(Order=1)
        public Integer Skip = null;

        @DataMember(Order=2)
        public Integer Take = null;

        @DataMember(Order=3)
        public String OrderBy = null;

        @DataMember(Order=4)
        public String OrderByDesc = null;

        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class FacilityInstance
    {
        public Integer FacilityId = null;
        public String Name = null;
        public String Description = null;
        public ScheduleInstance Schedule = null;
        @References(ScheduleInstance.class)
        public Integer ScheduleId = null;

        public String Colour = null;
        public Boolean Bookable = null;
        public Boolean Deleted = null;
        public Boolean Demo = null;
        public String Group = null;
        
        public Integer getFacilityId() { return FacilityId; }
        public FacilityInstance setFacilityId(Integer value) { this.FacilityId = value; return this; }
        public String getName() { return Name; }
        public FacilityInstance setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public FacilityInstance setDescription(String value) { this.Description = value; return this; }
        public ScheduleInstance getSchedule() { return Schedule; }
        public FacilityInstance setSchedule(ScheduleInstance value) { this.Schedule = value; return this; }
        public Integer getScheduleId() { return ScheduleId; }
        public FacilityInstance setScheduleId(Integer value) { this.ScheduleId = value; return this; }
        public String getColour() { return Colour; }
        public FacilityInstance setColour(String value) { this.Colour = value; return this; }
        public Boolean isBookable() { return Bookable; }
        public FacilityInstance setBookable(Boolean value) { this.Bookable = value; return this; }
        public Boolean isDeleted() { return Deleted; }
        public FacilityInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
        public Boolean isDemo() { return Demo; }
        public FacilityInstance setDemo(Boolean value) { this.Demo = value; return this; }
        public String getGroup() { return Group; }
        public FacilityInstance setGroup(String value) { this.Group = value; return this; }
    }

    public static class ScheduleInstance
    {
        public Integer ScheduleId = null;
        public String Name = null;
        public String Description = null;
        public TimeSpan MondayFrom = null;
        public TimeSpan MondayTo = null;
        public TimeSpan TuesdayFrom = null;
        public TimeSpan TuesdayTo = null;
        public TimeSpan WednesdayFrom = null;
        public TimeSpan WednesdayTo = null;
        public TimeSpan ThursdayFrom = null;
        public TimeSpan ThursdayTo = null;
        public TimeSpan FridayFrom = null;
        public TimeSpan FridayTo = null;
        public TimeSpan SaturdayFrom = null;
        public TimeSpan SaturdayTo = null;
        public TimeSpan SundayFrom = null;
        public TimeSpan SundayTo = null;
        public Integer ScheduleType = null;
        public Boolean Deleted = null;
        public Boolean Demo = null;
        
        public Integer getScheduleId() { return ScheduleId; }
        public ScheduleInstance setScheduleId(Integer value) { this.ScheduleId = value; return this; }
        public String getName() { return Name; }
        public ScheduleInstance setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public ScheduleInstance setDescription(String value) { this.Description = value; return this; }
        public TimeSpan getMondayFrom() { return MondayFrom; }
        public ScheduleInstance setMondayFrom(TimeSpan value) { this.MondayFrom = value; return this; }
        public TimeSpan getMondayTo() { return MondayTo; }
        public ScheduleInstance setMondayTo(TimeSpan value) { this.MondayTo = value; return this; }
        public TimeSpan getTuesdayFrom() { return TuesdayFrom; }
        public ScheduleInstance setTuesdayFrom(TimeSpan value) { this.TuesdayFrom = value; return this; }
        public TimeSpan getTuesdayTo() { return TuesdayTo; }
        public ScheduleInstance setTuesdayTo(TimeSpan value) { this.TuesdayTo = value; return this; }
        public TimeSpan getWednesdayFrom() { return WednesdayFrom; }
        public ScheduleInstance setWednesdayFrom(TimeSpan value) { this.WednesdayFrom = value; return this; }
        public TimeSpan getWednesdayTo() { return WednesdayTo; }
        public ScheduleInstance setWednesdayTo(TimeSpan value) { this.WednesdayTo = value; return this; }
        public TimeSpan getThursdayFrom() { return ThursdayFrom; }
        public ScheduleInstance setThursdayFrom(TimeSpan value) { this.ThursdayFrom = value; return this; }
        public TimeSpan getThursdayTo() { return ThursdayTo; }
        public ScheduleInstance setThursdayTo(TimeSpan value) { this.ThursdayTo = value; return this; }
        public TimeSpan getFridayFrom() { return FridayFrom; }
        public ScheduleInstance setFridayFrom(TimeSpan value) { this.FridayFrom = value; return this; }
        public TimeSpan getFridayTo() { return FridayTo; }
        public ScheduleInstance setFridayTo(TimeSpan value) { this.FridayTo = value; return this; }
        public TimeSpan getSaturdayFrom() { return SaturdayFrom; }
        public ScheduleInstance setSaturdayFrom(TimeSpan value) { this.SaturdayFrom = value; return this; }
        public TimeSpan getSaturdayTo() { return SaturdayTo; }
        public ScheduleInstance setSaturdayTo(TimeSpan value) { this.SaturdayTo = value; return this; }
        public TimeSpan getSundayFrom() { return SundayFrom; }
        public ScheduleInstance setSundayFrom(TimeSpan value) { this.SundayFrom = value; return this; }
        public TimeSpan getSundayTo() { return SundayTo; }
        public ScheduleInstance setSundayTo(TimeSpan value) { this.SundayTo = value; return this; }
        public Integer getScheduleType() { return ScheduleType; }
        public ScheduleInstance setScheduleType(Integer value) { this.ScheduleType = value; return this; }
        public Boolean isDeleted() { return Deleted; }
        public ScheduleInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
        public Boolean isDemo() { return Demo; }
        public ScheduleInstance setDemo(Boolean value) { this.Demo = value; return this; }
    }

    @DataContract
    public static class QueryResponse<T>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<T> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<T> getResults() { return Results; }
        public QueryResponse<T> setResults(ArrayList<T> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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>