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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

    getTypeName() => "QueryBase";
    TypeContext? context = _ctx;
}

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

class ScheduleInstance implements IConvertible
{
    int? ScheduleId;
    String? Name;
    String? Description;
    Duration? MondayFrom;
    Duration? MondayTo;
    Duration? TuesdayFrom;
    Duration? TuesdayTo;
    Duration? WednesdayFrom;
    Duration? WednesdayTo;
    Duration? ThursdayFrom;
    Duration? ThursdayTo;
    Duration? FridayFrom;
    Duration? FridayTo;
    Duration? SaturdayFrom;
    Duration? SaturdayTo;
    Duration? SundayFrom;
    Duration? SundayTo;
    int? ScheduleType;
    bool? Deleted;
    bool? Demo;

    ScheduleInstance({this.ScheduleId,this.Name,this.Description,this.MondayFrom,this.MondayTo,this.TuesdayFrom,this.TuesdayTo,this.WednesdayFrom,this.WednesdayTo,this.ThursdayFrom,this.ThursdayTo,this.FridayFrom,this.FridayTo,this.SaturdayFrom,this.SaturdayTo,this.SundayFrom,this.SundayTo,this.ScheduleType,this.Deleted,this.Demo});
    ScheduleInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ScheduleId = json['ScheduleId'];
        Name = json['Name'];
        Description = json['Description'];
        MondayFrom = JsonConverters.fromJson(json['MondayFrom'],'Duration',context!);
        MondayTo = JsonConverters.fromJson(json['MondayTo'],'Duration',context!);
        TuesdayFrom = JsonConverters.fromJson(json['TuesdayFrom'],'Duration',context!);
        TuesdayTo = JsonConverters.fromJson(json['TuesdayTo'],'Duration',context!);
        WednesdayFrom = JsonConverters.fromJson(json['WednesdayFrom'],'Duration',context!);
        WednesdayTo = JsonConverters.fromJson(json['WednesdayTo'],'Duration',context!);
        ThursdayFrom = JsonConverters.fromJson(json['ThursdayFrom'],'Duration',context!);
        ThursdayTo = JsonConverters.fromJson(json['ThursdayTo'],'Duration',context!);
        FridayFrom = JsonConverters.fromJson(json['FridayFrom'],'Duration',context!);
        FridayTo = JsonConverters.fromJson(json['FridayTo'],'Duration',context!);
        SaturdayFrom = JsonConverters.fromJson(json['SaturdayFrom'],'Duration',context!);
        SaturdayTo = JsonConverters.fromJson(json['SaturdayTo'],'Duration',context!);
        SundayFrom = JsonConverters.fromJson(json['SundayFrom'],'Duration',context!);
        SundayTo = JsonConverters.fromJson(json['SundayTo'],'Duration',context!);
        ScheduleType = json['ScheduleType'];
        Deleted = json['Deleted'];
        Demo = json['Demo'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ScheduleId': ScheduleId,
        'Name': Name,
        'Description': Description,
        'MondayFrom': JsonConverters.toJson(MondayFrom,'Duration',context!),
        'MondayTo': JsonConverters.toJson(MondayTo,'Duration',context!),
        'TuesdayFrom': JsonConverters.toJson(TuesdayFrom,'Duration',context!),
        'TuesdayTo': JsonConverters.toJson(TuesdayTo,'Duration',context!),
        'WednesdayFrom': JsonConverters.toJson(WednesdayFrom,'Duration',context!),
        'WednesdayTo': JsonConverters.toJson(WednesdayTo,'Duration',context!),
        'ThursdayFrom': JsonConverters.toJson(ThursdayFrom,'Duration',context!),
        'ThursdayTo': JsonConverters.toJson(ThursdayTo,'Duration',context!),
        'FridayFrom': JsonConverters.toJson(FridayFrom,'Duration',context!),
        'FridayTo': JsonConverters.toJson(FridayTo,'Duration',context!),
        'SaturdayFrom': JsonConverters.toJson(SaturdayFrom,'Duration',context!),
        'SaturdayTo': JsonConverters.toJson(SaturdayTo,'Duration',context!),
        'SundayFrom': JsonConverters.toJson(SundayFrom,'Duration',context!),
        'SundayTo': JsonConverters.toJson(SundayTo,'Duration',context!),
        'ScheduleType': ScheduleType,
        'Deleted': Deleted,
        'Demo': Demo
    };

    getTypeName() => "ScheduleInstance";
    TypeContext? context = _ctx;
}

class FacilityInstance implements IConvertible
{
    int? FacilityId;
    String? Name;
    String? Description;
    ScheduleInstance? Schedule;
    // @References(typeof(ScheduleInstance))
    int? ScheduleId;

    String? Colour;
    bool? Bookable;
    bool? Deleted;
    bool? Demo;
    String? Group;

    FacilityInstance({this.FacilityId,this.Name,this.Description,this.Schedule,this.ScheduleId,this.Colour,this.Bookable,this.Deleted,this.Demo,this.Group});
    FacilityInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FacilityId = json['FacilityId'];
        Name = json['Name'];
        Description = json['Description'];
        Schedule = JsonConverters.fromJson(json['Schedule'],'ScheduleInstance',context!);
        ScheduleId = json['ScheduleId'];
        Colour = json['Colour'];
        Bookable = json['Bookable'];
        Deleted = json['Deleted'];
        Demo = json['Demo'];
        Group = json['Group'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FacilityId': FacilityId,
        'Name': Name,
        'Description': Description,
        'Schedule': JsonConverters.toJson(Schedule,'ScheduleInstance',context!),
        'ScheduleId': ScheduleId,
        'Colour': Colour,
        'Bookable': Bookable,
        'Deleted': Deleted,
        'Demo': Demo,
        'Group': Group
    };

    getTypeName() => "FacilityInstance";
    TypeContext? context = _ctx;
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Facility")
class FindFacility extends QueryDb<FacilityInstance> implements IConvertible
{
    FindFacility();
    FindFacility.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "FindFacility";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<T>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<T>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.clubmanagercentral.com', types: <String, TypeInfo> {
    'ScheduleInstance': TypeInfo(TypeOf.Class, create:() => ScheduleInstance()),
    'FacilityInstance': TypeInfo(TypeOf.Class, create:() => FacilityInstance()),
    'FindFacility': TypeInfo(TypeOf.Class, create:() => FindFacility()),
    'List<FacilityInstance>': TypeInfo(TypeOf.Class, create:() => <FacilityInstance>[]),
});

Dart FindFacility DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"Offset":0,"Total":0,"Results":[{"FacilityId":0,"Name":"String","Description":"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,"Colour":"String","Bookable":false,"Deleted":false,"Demo":false,"Group":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}