| GET | /homepage/menu | Find news items for a company |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
abstract class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
// @DataMember(Order=1)
int? Skip;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
// @DataMember(Order=2)
int? Take;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
// @DataMember(Order=3)
String? OrderBy;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
// @DataMember(Order=4)
String? OrderByDesc;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
// @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 QueryDb2<From,Into> extends QueryBase
{
QueryDb2();
QueryDb2.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<$From,$Into>";
TypeContext? context = _ctx;
}
class HomepageMenuQueryResponse implements IConvertible
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
String? CompanyId;
/**
* The text for home menu item
*/
// @ApiMember(Description="The text for home menu item")
String? HomeText;
/**
* If the home menu item should be hidden
*/
// @ApiMember(Description="If the home menu item should be hidden")
bool? HomeHidden;
/**
* The text for services menu item
*/
// @ApiMember(Description="The text for services menu item")
String? ServicesText;
/**
* If the services menu item should be hidden
*/
// @ApiMember(Description="If the services menu item should be hidden")
bool? ServicesHidden;
/**
* The text for book time menu item
*/
// @ApiMember(Description="The text for book time menu item")
String? BookTimeText;
/**
* If the book time menu item should be hidden
*/
// @ApiMember(Description="If the book time menu item should be hidden")
bool? BookTimeHidden;
/**
* The text for about us menu item
*/
// @ApiMember(Description="The text for about us menu item")
String? AboutUsText;
/**
* If the about us menu item should be hidden
*/
// @ApiMember(Description="If the about us menu item should be hidden")
bool? AboutUsHidden;
/**
* The text for contact us menu item
*/
// @ApiMember(Description="The text for contact us menu item")
String? ContactUsText;
/**
* If the contact us menu item should be hidden
*/
// @ApiMember(Description="If the contact us menu item should be hidden")
bool? ContactUsHidden;
/**
* The text for my bookings menu item
*/
// @ApiMember(Description="The text for my bookings menu item")
String? MyBookingsText;
/**
* If the my bookings menu item should be hidden
*/
// @ApiMember(Description="If the my bookings menu item should be hidden")
bool? MyBookingsHidden;
/**
* The text for calender menu item
*/
// @ApiMember(Description="The text for calender menu item")
String? CalendarText;
/**
* If the calendar menu item should be hidden
*/
// @ApiMember(Description="If the calendar menu item should be hidden")
bool? CalendarHidden;
/**
* The text for news menu item
*/
// @ApiMember(Description="The text for news menu item")
String? NewsText;
/**
* If the news menu item should be hidden
*/
// @ApiMember(Description="If the news menu item should be hidden")
bool? NewsHidden;
/**
* The text for address menu item
*/
// @ApiMember(Description="The text for address menu item")
String? AddressText;
/**
* If the address menu item should be hidden
*/
// @ApiMember(Description="If the address menu item should be hidden")
bool? AddressHidden;
/**
* The text for gallery menu item
*/
// @ApiMember(Description="The text for gallery menu item")
String? GalleryText;
/**
* If the gallery menu item should be hidden
*/
// @ApiMember(Description="If the gallery menu item should be hidden")
bool? GalleryHidden;
ResponseStatus? ResponseStatus;
HomepageMenuQueryResponse({this.CompanyId,this.HomeText,this.HomeHidden,this.ServicesText,this.ServicesHidden,this.BookTimeText,this.BookTimeHidden,this.AboutUsText,this.AboutUsHidden,this.ContactUsText,this.ContactUsHidden,this.MyBookingsText,this.MyBookingsHidden,this.CalendarText,this.CalendarHidden,this.NewsText,this.NewsHidden,this.AddressText,this.AddressHidden,this.GalleryText,this.GalleryHidden,this.ResponseStatus});
HomepageMenuQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
HomeText = json['HomeText'];
HomeHidden = json['HomeHidden'];
ServicesText = json['ServicesText'];
ServicesHidden = json['ServicesHidden'];
BookTimeText = json['BookTimeText'];
BookTimeHidden = json['BookTimeHidden'];
AboutUsText = json['AboutUsText'];
AboutUsHidden = json['AboutUsHidden'];
ContactUsText = json['ContactUsText'];
ContactUsHidden = json['ContactUsHidden'];
MyBookingsText = json['MyBookingsText'];
MyBookingsHidden = json['MyBookingsHidden'];
CalendarText = json['CalendarText'];
CalendarHidden = json['CalendarHidden'];
NewsText = json['NewsText'];
NewsHidden = json['NewsHidden'];
AddressText = json['AddressText'];
AddressHidden = json['AddressHidden'];
GalleryText = json['GalleryText'];
GalleryHidden = json['GalleryHidden'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'HomeText': HomeText,
'HomeHidden': HomeHidden,
'ServicesText': ServicesText,
'ServicesHidden': ServicesHidden,
'BookTimeText': BookTimeText,
'BookTimeHidden': BookTimeHidden,
'AboutUsText': AboutUsText,
'AboutUsHidden': AboutUsHidden,
'ContactUsText': ContactUsText,
'ContactUsHidden': ContactUsHidden,
'MyBookingsText': MyBookingsText,
'MyBookingsHidden': MyBookingsHidden,
'CalendarText': CalendarText,
'CalendarHidden': CalendarHidden,
'NewsText': NewsText,
'NewsHidden': NewsHidden,
'AddressText': AddressText,
'AddressHidden': AddressHidden,
'GalleryText': GalleryText,
'GalleryHidden': GalleryHidden,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "HomepageMenuQueryResponse";
TypeContext? context = _ctx;
}
class BaseModel implements IConvertible
{
BaseModel();
BaseModel.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "BaseModel";
TypeContext? context = _ctx;
}
class HomepageMenu extends BaseModel implements IConvertible
{
// @Required()
String? HomeText;
// @Required()
bool? HomeHidden;
// @Required()
String? ServicesText;
// @Required()
bool? ServicesHidden;
// @Required()
String? BookTimeText;
// @Required()
bool? BookTimeHidden;
// @Required()
String? AboutUsText;
// @Required()
bool? AboutUsHidden;
// @Required()
String? ContactUsText;
// @Required()
bool? ContactUsHidden;
// @Required()
String? MyBookingsText;
// @Required()
bool? MyBookingsHidden;
// @Required()
String? CalendarText;
// @Required()
bool? CalendarHidden;
// @Required()
String? NewsText;
// @Required()
bool? NewsHidden;
// @Required()
String? AddressText;
// @Required()
bool? AddressHidden;
// @Required()
String? GalleryText;
// @Required()
bool? GalleryHidden;
DateTime? ModifiedDate;
// @Required()
String? Id;
HomepageMenu({this.HomeText,this.HomeHidden,this.ServicesText,this.ServicesHidden,this.BookTimeText,this.BookTimeHidden,this.AboutUsText,this.AboutUsHidden,this.ContactUsText,this.ContactUsHidden,this.MyBookingsText,this.MyBookingsHidden,this.CalendarText,this.CalendarHidden,this.NewsText,this.NewsHidden,this.AddressText,this.AddressHidden,this.GalleryText,this.GalleryHidden,this.ModifiedDate,this.Id});
HomepageMenu.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
HomeText = json['HomeText'];
HomeHidden = json['HomeHidden'];
ServicesText = json['ServicesText'];
ServicesHidden = json['ServicesHidden'];
BookTimeText = json['BookTimeText'];
BookTimeHidden = json['BookTimeHidden'];
AboutUsText = json['AboutUsText'];
AboutUsHidden = json['AboutUsHidden'];
ContactUsText = json['ContactUsText'];
ContactUsHidden = json['ContactUsHidden'];
MyBookingsText = json['MyBookingsText'];
MyBookingsHidden = json['MyBookingsHidden'];
CalendarText = json['CalendarText'];
CalendarHidden = json['CalendarHidden'];
NewsText = json['NewsText'];
NewsHidden = json['NewsHidden'];
AddressText = json['AddressText'];
AddressHidden = json['AddressHidden'];
GalleryText = json['GalleryText'];
GalleryHidden = json['GalleryHidden'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'HomeText': HomeText,
'HomeHidden': HomeHidden,
'ServicesText': ServicesText,
'ServicesHidden': ServicesHidden,
'BookTimeText': BookTimeText,
'BookTimeHidden': BookTimeHidden,
'AboutUsText': AboutUsText,
'AboutUsHidden': AboutUsHidden,
'ContactUsText': ContactUsText,
'ContactUsHidden': ContactUsHidden,
'MyBookingsText': MyBookingsText,
'MyBookingsHidden': MyBookingsHidden,
'CalendarText': CalendarText,
'CalendarHidden': CalendarHidden,
'NewsText': NewsText,
'NewsHidden': NewsHidden,
'AddressText': AddressText,
'AddressHidden': AddressHidden,
'GalleryText': GalleryText,
'GalleryHidden': GalleryHidden,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "HomepageMenu";
TypeContext? context = _ctx;
}
class HomepageMenuQuery extends QueryDb2<HomepageMenu,HomepageMenuQueryResponse> implements ICompanyRequest, IConvertible
{
/**
* Enter the company you want to see news for, if blank and you are an admin, your company id will be used
*/
// @ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")
String? CompanyId;
/**
* The homeage sitepath.
*/
// @ApiMember(Description="The homeage sitepath.")
String? SitePath;
HomepageMenuQuery({this.CompanyId,this.SitePath});
HomepageMenuQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CompanyId = json['CompanyId'];
SitePath = json['SitePath'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CompanyId': CompanyId,
'SitePath': SitePath
});
getTypeName() => "HomepageMenuQuery";
TypeContext? context = _ctx;
}
class AccessKeyTypeResponse implements IConvertible
{
int? Id;
String? KeyType;
String? Description;
AccessKeyTypeResponse({this.Id,this.KeyType,this.Description});
AccessKeyTypeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
KeyType = json['KeyType'];
Description = json['Description'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'KeyType': KeyType,
'Description': Description
};
getTypeName() => "AccessKeyTypeResponse";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<AccessKeyTypeResponse> implements IConvertible
{
// @DataMember(Order=1)
int? Offset;
// @DataMember(Order=2)
int? Total;
// @DataMember(Order=3)
List<AccessKeyTypeResponse>? 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<AccessKeyTypeResponse>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$AccessKeyTypeResponse>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'HomepageMenuQueryResponse': TypeInfo(TypeOf.Class, create:() => HomepageMenuQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'HomepageMenu': TypeInfo(TypeOf.Class, create:() => HomepageMenu()),
'HomepageMenuQuery': TypeInfo(TypeOf.Class, create:() => HomepageMenuQuery()),
'List<HomepageMenuQueryResponse>': TypeInfo(TypeOf.Class, create:() => <HomepageMenuQueryResponse>[]),
'AccessKeyTypeResponse': TypeInfo(TypeOf.Class, create:() => AccessKeyTypeResponse()),
'QueryResponse<AccessKeyTypeResponse>': TypeInfo(TypeOf.Class, create:() => QueryResponse<AccessKeyTypeResponse>()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/menu HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
HomeText: String,
HomeHidden: False,
ServicesText: String,
ServicesHidden: False,
BookTimeText: String,
BookTimeHidden: False,
AboutUsText: String,
AboutUsHidden: False,
ContactUsText: String,
ContactUsHidden: False,
MyBookingsText: String,
MyBookingsHidden: False,
CalendarText: String,
CalendarHidden: False,
NewsText: String,
NewsHidden: False,
AddressText: String,
AddressHidden: False,
GalleryText: String,
GalleryHidden: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}