Required role: | API |
All Verbs | /api/Query/Template |
---|
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 TemplateInstance implements IConvertible
{
int? TemplateId;
String? Description;
String? TemplateHtml;
bool? IsEnabled;
bool? IsSystem;
int? TemplateType;
int? EventType;
bool? Deleted;
bool? Demo;
TemplateInstance({this.TemplateId,this.Description,this.TemplateHtml,this.IsEnabled,this.IsSystem,this.TemplateType,this.EventType,this.Deleted,this.Demo});
TemplateInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
TemplateId = json['TemplateId'];
Description = json['Description'];
TemplateHtml = json['TemplateHtml'];
IsEnabled = json['IsEnabled'];
IsSystem = json['IsSystem'];
TemplateType = json['TemplateType'];
EventType = json['EventType'];
Deleted = json['Deleted'];
Demo = json['Demo'];
return this;
}
Map<String, dynamic> toJson() => {
'TemplateId': TemplateId,
'Description': Description,
'TemplateHtml': TemplateHtml,
'IsEnabled': IsEnabled,
'IsSystem': IsSystem,
'TemplateType': TemplateType,
'EventType': EventType,
'Deleted': Deleted,
'Demo': Demo
};
getTypeName() => "TemplateInstance";
TypeContext? context = _ctx;
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Template")
class FindTemplate extends QueryDb<TemplateInstance> implements IConvertible
{
FindTemplate();
FindTemplate.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() => "FindTemplate";
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> {
'TemplateInstance': TypeInfo(TypeOf.Class, create:() => TemplateInstance()),
'FindTemplate': TypeInfo(TypeOf.Class, create:() => FindTemplate()),
'List<TemplateInstance>': TypeInfo(TypeOf.Class, create:() => <TemplateInstance>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/Template HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindTemplate 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>
</FindTemplate>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfTemplateInstancePEZRWkv_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:TemplateInstance> <d2p1:Deleted>false</d2p1:Deleted> <d2p1:Demo>false</d2p1:Demo> <d2p1:Description>String</d2p1:Description> <d2p1:EventType>0</d2p1:EventType> <d2p1:IsEnabled>false</d2p1:IsEnabled> <d2p1:IsSystem>false</d2p1:IsSystem> <d2p1:TemplateHtml>String</d2p1:TemplateHtml> <d2p1:TemplateId>0</d2p1:TemplateId> <d2p1:TemplateType>0</d2p1:TemplateType> </d2p1:TemplateInstance> </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> </QueryResponseOfTemplateInstancePEZRWkv_P>