| GET | /api/GetSchedulingGroupings |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
class BaseRequest implements IConvertible
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
String? ApiKey;
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
String? OAuthToken;
BaseRequest({this.ApiKey,this.OAuthToken});
BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
OAuthToken = json['OAuthToken'];
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey,
'OAuthToken': OAuthToken
};
getTypeName() => "BaseRequest";
TypeContext? context = _ctx;
}
// @DataContract
class BaseResponseResult implements IConvertible
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
String? StatusCode;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
String? Login;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
String? ErrorCode;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
String? ErrorDisplayText;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
String? ErrorMessage;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
String? DomainName;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
String? IpAddress;
BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
StatusCode = json['StatusCode'];
Login = json['Login'];
ErrorCode = json['ErrorCode'];
ErrorDisplayText = json['ErrorDisplayText'];
ErrorMessage = json['ErrorMessage'];
DomainName = json['DomainName'];
IpAddress = json['IpAddress'];
return this;
}
Map<String, dynamic> toJson() => {
'StatusCode': StatusCode,
'Login': Login,
'ErrorCode': ErrorCode,
'ErrorDisplayText': ErrorDisplayText,
'ErrorMessage': ErrorMessage,
'DomainName': DomainName,
'IpAddress': IpAddress
};
getTypeName() => "BaseResponseResult";
TypeContext? context = _ctx;
}
// @DataContract
class BaseResponse implements IConvertible
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
BaseResponseResult? Status;
BaseResponse({this.Status});
BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
};
getTypeName() => "BaseResponse";
TypeContext? context = _ctx;
}
// @DataContract
class GroupingInfo implements IConvertible
{
// @DataMember
int? Id;
// @DataMember
String? Desc;
GroupingInfo({this.Id,this.Desc});
GroupingInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Desc = json['Desc'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Desc': Desc
};
getTypeName() => "GroupingInfo";
TypeContext? context = _ctx;
}
// @DataContract
class GetSchedulingGroupingsResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<GroupingInfo>? Groupings;
GetSchedulingGroupingsResponse({this.Groupings});
GetSchedulingGroupingsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Groupings = JsonConverters.fromJson(json['Groupings'],'List<GroupingInfo>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Groupings': JsonConverters.toJson(Groupings,'List<GroupingInfo>',context!)
});
getTypeName() => "GetSchedulingGroupingsResponse";
TypeContext? context = _ctx;
}
/**
* GetSchedulingGroupingsRequires active-e Lesson Scheduling Service
*/
// @DataContract
class GetSchedulingGroupingsRequest extends BaseRequest implements IConvertible
{
/**
* Grouping ID to look up. If sent, all other parameters will be ignored.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="Grouping ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="GroupingId", ParameterType="query")
int? GroupingId;
/**
* If sent, only groupings with at least one lesson type taught by the sent instructor will be returned.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only groupings with at least one lesson type taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
int? InstructorId;
/**
* If sent, only groupings taught at the sent location will be returned.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, only groupings taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
int? LocationId;
/**
* If sent, should be Private or Group. If Private, only groupings containing Private Lesson Types will be returned. If Group, only groupings containing Group Lesson Types will be returned.
*/
// @DataMember
// @ApiMember(DataType="integer", Description="If sent, should be Private or Group. If Private, only groupings containing Private Lesson Types will be returned. If Group, only groupings containing Group Lesson Types will be returned.", Format="int64", Name="MembershipType", ParameterType="query")
String? MembershipType;
GetSchedulingGroupingsRequest({this.GroupingId,this.InstructorId,this.LocationId,this.MembershipType});
GetSchedulingGroupingsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
GroupingId = json['GroupingId'];
InstructorId = json['InstructorId'];
LocationId = json['LocationId'];
MembershipType = json['MembershipType'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'GroupingId': GroupingId,
'InstructorId': InstructorId,
'LocationId': LocationId,
'MembershipType': MembershipType
});
getTypeName() => "GetSchedulingGroupingsRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
'GroupingInfo': TypeInfo(TypeOf.Class, create:() => GroupingInfo()),
'GetSchedulingGroupingsResponse': TypeInfo(TypeOf.Class, create:() => GetSchedulingGroupingsResponse()),
'List<GroupingInfo>': TypeInfo(TypeOf.Class, create:() => <GroupingInfo>[]),
'GetSchedulingGroupingsRequest': TypeInfo(TypeOf.Class, create:() => GetSchedulingGroupingsRequest()),
});
Dart GetSchedulingGroupingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/GetSchedulingGroupings HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Groupings":[{"Id":0,"Desc":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}