ClubManager.Api

<back to all web services

FindSchedule

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/Schedule
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="Schedule")
    public static class FindSchedule extends QueryDb<ScheduleInstance>
    {
        
    }

    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 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 FindSchedule 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/Schedule 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: 
	[
		{
			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
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}