| GET | /licenses/types/ | Get all license types | This service is used to get get all license types that exists. |
|---|
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 LicenseInformationQueryResponse implements IConvertible
{
String? Name;
String? Description;
Uri? Url;
bool? FreeEdition;
bool? StartEdition;
bool? ProEdition;
bool? SmartEdition;
bool? EnterpriseEdition;
String? FreeEditionValue;
String? StartEditionValue;
String? ProEditionValue;
String? SmartEditionValue;
String? EnterpriseEditionValue;
int? LicenseInformationTypeId;
LicenseInformationQueryResponse({this.Name,this.Description,this.Url,this.FreeEdition,this.StartEdition,this.ProEdition,this.SmartEdition,this.EnterpriseEdition,this.FreeEditionValue,this.StartEditionValue,this.ProEditionValue,this.SmartEditionValue,this.EnterpriseEditionValue,this.LicenseInformationTypeId});
LicenseInformationQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Name = json['Name'];
Description = json['Description'];
Url = JsonConverters.fromJson(json['Url'],'Uri',context!);
FreeEdition = json['FreeEdition'];
StartEdition = json['StartEdition'];
ProEdition = json['ProEdition'];
SmartEdition = json['SmartEdition'];
EnterpriseEdition = json['EnterpriseEdition'];
FreeEditionValue = json['FreeEditionValue'];
StartEditionValue = json['StartEditionValue'];
ProEditionValue = json['ProEditionValue'];
SmartEditionValue = json['SmartEditionValue'];
EnterpriseEditionValue = json['EnterpriseEditionValue'];
LicenseInformationTypeId = json['LicenseInformationTypeId'];
return this;
}
Map<String, dynamic> toJson() => {
'Name': Name,
'Description': Description,
'Url': JsonConverters.toJson(Url,'Uri',context!),
'FreeEdition': FreeEdition,
'StartEdition': StartEdition,
'ProEdition': ProEdition,
'SmartEdition': SmartEdition,
'EnterpriseEdition': EnterpriseEdition,
'FreeEditionValue': FreeEditionValue,
'StartEditionValue': StartEditionValue,
'ProEditionValue': ProEditionValue,
'SmartEditionValue': SmartEditionValue,
'EnterpriseEditionValue': EnterpriseEditionValue,
'LicenseInformationTypeId': LicenseInformationTypeId
};
getTypeName() => "LicenseInformationQueryResponse";
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 LicenseTypeItem extends BaseModel implements IConvertible
{
// @Ignore()
String? Name;
// @Ignore()
LicenseType? LicenseType;
// @Required()
int? LicenseTypesId;
// @Required()
int? LicenseItemsId;
// @Required()
int? NumberOfItems;
int? Id;
DateTime? ModifiedDate;
LicenseTypeItem({this.Name,this.LicenseType,this.LicenseTypesId,this.LicenseItemsId,this.NumberOfItems,this.Id,this.ModifiedDate});
LicenseTypeItem.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Name = json['Name'];
LicenseType = JsonConverters.fromJson(json['LicenseType'],'LicenseType',context!);
LicenseTypesId = json['LicenseTypesId'];
LicenseItemsId = json['LicenseItemsId'];
NumberOfItems = json['NumberOfItems'];
Id = json['Id'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Name': Name,
'LicenseType': JsonConverters.toJson(LicenseType,'LicenseType',context!),
'LicenseTypesId': LicenseTypesId,
'LicenseItemsId': LicenseItemsId,
'NumberOfItems': NumberOfItems,
'Id': Id,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "LicenseTypeItem";
TypeContext? context = _ctx;
}
class Currency extends BaseModel implements IConvertible
{
// @Required()
String? Name;
// @Required()
String? CurrencySign;
// @Required()
bool? Active;
DateTime? ModifiedDate;
// @Required()
String? Id;
Currency({this.Name,this.CurrencySign,this.Active,this.ModifiedDate,this.Id});
Currency.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Name = json['Name'];
CurrencySign = json['CurrencySign'];
Active = json['Active'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Name': Name,
'CurrencySign': CurrencySign,
'Active': Active,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "Currency";
TypeContext? context = _ctx;
}
class Country extends BaseModel implements IConvertible
{
// @References(typeof(Currency))
String? CurrencyId;
Currency? CurrencyInfo;
// @Required()
String? Name;
String? Culture;
String? TimeZone;
DateTime? ModifiedDate;
// @Required()
String? Id;
Country({this.CurrencyId,this.CurrencyInfo,this.Name,this.Culture,this.TimeZone,this.ModifiedDate,this.Id});
Country.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CurrencyId = json['CurrencyId'];
CurrencyInfo = JsonConverters.fromJson(json['CurrencyInfo'],'Currency',context!);
Name = json['Name'];
Culture = json['Culture'];
TimeZone = json['TimeZone'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CurrencyId': CurrencyId,
'CurrencyInfo': JsonConverters.toJson(CurrencyInfo,'Currency',context!),
'Name': Name,
'Culture': Culture,
'TimeZone': TimeZone,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "Country";
TypeContext? context = _ctx;
}
class LicensePrice extends BaseModel implements IConvertible
{
// @Ignore()
Country? Country;
// @Ignore()
bool? MonthlyPayment;
// @Required()
int? LicenseTypeId;
// @Required()
String? CountryId;
// @Required()
int? Price;
DateTime? ModifiedDate;
LicensePrice({this.Country,this.MonthlyPayment,this.LicenseTypeId,this.CountryId,this.Price,this.ModifiedDate});
LicensePrice.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Country = JsonConverters.fromJson(json['Country'],'Country',context!);
MonthlyPayment = json['MonthlyPayment'];
LicenseTypeId = json['LicenseTypeId'];
CountryId = json['CountryId'];
Price = json['Price'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Country': JsonConverters.toJson(Country,'Country',context!),
'MonthlyPayment': MonthlyPayment,
'LicenseTypeId': LicenseTypeId,
'CountryId': CountryId,
'Price': Price,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "LicensePrice";
TypeContext? context = _ctx;
}
class LicenseType extends BaseModel implements IConvertible
{
// @Ignore()
List<LicenseTypeItem>? LicenseItems;
// @Ignore()
List<LicensePrice>? Prices;
// @Ignore()
int? PeriodOfNoticeDays;
// @Ignore()
LicenseType? NextLicenseOption;
// @Required()
String? Name;
// @Required()
String? Description;
// @Required()
bool? ExtraLicenseOption;
DateTime? ModifiedDate;
bool? Active;
int? Id;
LicenseType({this.LicenseItems,this.Prices,this.PeriodOfNoticeDays,this.NextLicenseOption,this.Name,this.Description,this.ExtraLicenseOption,this.ModifiedDate,this.Active,this.Id});
LicenseType.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
LicenseItems = JsonConverters.fromJson(json['LicenseItems'],'List<LicenseTypeItem>',context!);
Prices = JsonConverters.fromJson(json['Prices'],'List<LicensePrice>',context!);
PeriodOfNoticeDays = json['PeriodOfNoticeDays'];
NextLicenseOption = JsonConverters.fromJson(json['NextLicenseOption'],'LicenseType',context!);
Name = json['Name'];
Description = json['Description'];
ExtraLicenseOption = json['ExtraLicenseOption'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Active = json['Active'];
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'LicenseItems': JsonConverters.toJson(LicenseItems,'List<LicenseTypeItem>',context!),
'Prices': JsonConverters.toJson(Prices,'List<LicensePrice>',context!),
'PeriodOfNoticeDays': PeriodOfNoticeDays,
'NextLicenseOption': JsonConverters.toJson(NextLicenseOption,'LicenseType',context!),
'Name': Name,
'Description': Description,
'ExtraLicenseOption': ExtraLicenseOption,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Active': Active,
'Id': Id
});
getTypeName() => "LicenseType";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class LicenseTypeQuery extends QueryDb2<LicenseType,LicenseInformationQueryResponse> implements IConvertible
{
/**
* If you want to only select Extra license options
*/
// @ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
bool? ExtraLicenseOption;
/**
* What country you want to list the prices for
*/
// @ApiMember(DataType="string", Description="What country you want to list the prices for")
String? CountryId;
/**
* If you want to include the connected license items
*/
// @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
bool? IncludeLicenseItems;
/**
* If you want to include the connected licens prices
*/
// @ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
bool? IncludeLicensePrices;
ResponseStatus? ResponseStatus;
bool? Active;
LicenseTypeQuery({this.ExtraLicenseOption,this.CountryId,this.IncludeLicenseItems,this.IncludeLicensePrices,this.ResponseStatus,this.Active});
LicenseTypeQuery.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ExtraLicenseOption = json['ExtraLicenseOption'];
CountryId = json['CountryId'];
IncludeLicenseItems = json['IncludeLicenseItems'];
IncludeLicensePrices = json['IncludeLicensePrices'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
Active = json['Active'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ExtraLicenseOption': ExtraLicenseOption,
'CountryId': CountryId,
'IncludeLicenseItems': IncludeLicenseItems,
'IncludeLicensePrices': IncludeLicensePrices,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'Active': Active
});
getTypeName() => "LicenseTypeQuery";
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> {
'LicenseInformationQueryResponse': TypeInfo(TypeOf.Class, create:() => LicenseInformationQueryResponse()),
'Uri': TypeInfo(TypeOf.Class, create:() => Uri()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'LicenseTypeItem': TypeInfo(TypeOf.Class, create:() => LicenseTypeItem()),
'LicenseType': TypeInfo(TypeOf.Class, create:() => LicenseType()),
'Currency': TypeInfo(TypeOf.Class, create:() => Currency()),
'Country': TypeInfo(TypeOf.Class, create:() => Country()),
'LicensePrice': TypeInfo(TypeOf.Class, create:() => LicensePrice()),
'List<LicenseTypeItem>': TypeInfo(TypeOf.Class, create:() => <LicenseTypeItem>[]),
'List<LicensePrice>': TypeInfo(TypeOf.Class, create:() => <LicensePrice>[]),
'LicenseTypeQuery': TypeInfo(TypeOf.Class, create:() => LicenseTypeQuery()),
'List<LicenseInformationQueryResponse>': TypeInfo(TypeOf.Class, create:() => <LicenseInformationQueryResponse>[]),
'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 /licenses/types/ 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:
[
{
Name: String,
Description: String,
FreeEdition: False,
StartEdition: False,
ProEdition: False,
SmartEdition: False,
EnterpriseEdition: False,
FreeEditionValue: String,
StartEditionValue: String,
ProEditionValue: String,
SmartEditionValue: String,
EnterpriseEditionValue: String,
LicenseInformationTypeId: 0
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}