| GET | /licenses/plans/ | Get all license plans | This service is used to get get all license plans 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 VossPlanResponse implements IConvertible
{
String? Id;
String? Name;
String? LengthUnit;
String? Length;
VossPlanResponse({this.Id,this.Name,this.LengthUnit,this.Length});
VossPlanResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
LengthUnit = json['LengthUnit'];
Length = json['Length'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'LengthUnit': LengthUnit,
'Length': Length
};
getTypeName() => "VossPlanResponse";
TypeContext? context = _ctx;
}
enum LengthUnit
{
Week,
Month,
Year,
}
class LicensePlanQueryResponse implements IConvertible
{
int? Id;
String? VossPlanId;
String? Name;
String? Description;
VossPlanResponse? VossPlan;
int? PlanLength;
LengthUnit? PlanLengthUnit;
DateTime? UpdatedDate;
DateTime? CreatedDate;
LicensePlanQueryResponse({this.Id,this.VossPlanId,this.Name,this.Description,this.VossPlan,this.PlanLength,this.PlanLengthUnit,this.UpdatedDate,this.CreatedDate});
LicensePlanQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
VossPlanId = json['VossPlanId'];
Name = json['Name'];
Description = json['Description'];
VossPlan = JsonConverters.fromJson(json['VossPlan'],'VossPlanResponse',context!);
PlanLength = json['PlanLength'];
PlanLengthUnit = JsonConverters.fromJson(json['PlanLengthUnit'],'LengthUnit',context!);
UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'VossPlanId': VossPlanId,
'Name': Name,
'Description': Description,
'VossPlan': JsonConverters.toJson(VossPlan,'VossPlanResponse',context!),
'PlanLength': PlanLength,
'PlanLengthUnit': JsonConverters.toJson(PlanLengthUnit,'LengthUnit',context!),
'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!),
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
};
getTypeName() => "LicensePlanQueryResponse";
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 LicensePlan extends BaseModel implements IBaseModelUpdated, IBaseModelCreated, IConvertible
{
// @Ignore()
VossPlanResponse? VossPlan;
// @Required()
int? Id;
String? VossPlanId;
// @Required()
int? PlanLength;
// @Required()
int? PlanLengthUnitId;
// @Required()
String? Name;
// @Required()
String? Description;
DateTime? UpdatedDate;
DateTime? CreatedDate;
LicensePlan({this.VossPlan,this.Id,this.VossPlanId,this.PlanLength,this.PlanLengthUnitId,this.Name,this.Description,this.UpdatedDate,this.CreatedDate});
LicensePlan.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
VossPlan = JsonConverters.fromJson(json['VossPlan'],'VossPlanResponse',context!);
Id = json['Id'];
VossPlanId = json['VossPlanId'];
PlanLength = json['PlanLength'];
PlanLengthUnitId = json['PlanLengthUnitId'];
Name = json['Name'];
Description = json['Description'];
UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'VossPlan': JsonConverters.toJson(VossPlan,'VossPlanResponse',context!),
'Id': Id,
'VossPlanId': VossPlanId,
'PlanLength': PlanLength,
'PlanLengthUnitId': PlanLengthUnitId,
'Name': Name,
'Description': Description,
'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!),
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!)
});
getTypeName() => "LicensePlan";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
class LicensePlanQuery extends QueryDb2<LicensePlan,LicensePlanQueryResponse> implements IConvertible
{
LicensePlanQuery();
LicensePlanQuery.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() => "LicensePlanQuery";
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: 'testapi.bokamera.se', types: <String, TypeInfo> {
'VossPlanResponse': TypeInfo(TypeOf.Class, create:() => VossPlanResponse()),
'LengthUnit': TypeInfo(TypeOf.Enum, enumValues:LengthUnit.values),
'LicensePlanQueryResponse': TypeInfo(TypeOf.Class, create:() => LicensePlanQueryResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'LicensePlan': TypeInfo(TypeOf.Class, create:() => LicensePlan()),
'LicensePlanQuery': TypeInfo(TypeOf.Class, create:() => LicensePlanQuery()),
'List<LicensePlanQueryResponse>': TypeInfo(TypeOf.Class, create:() => <LicensePlanQueryResponse>[]),
'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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /licenses/plans/ HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfLicensePlanQueryResponseWg5EthtI 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/BokaMera.API.ServiceModel.Dtos">
<d2p1:LicensePlanQueryResponse>
<d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
<d2p1:PlanLength>0</d2p1:PlanLength>
<d2p1:PlanLengthUnit>Week</d2p1:PlanLengthUnit>
<d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
<d2p1:VossPlan>
<d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
<d2p1:Length>String</d2p1:Length>
<d2p1:LengthUnit>String</d2p1:LengthUnit>
<d2p1:Name>String</d2p1:Name>
</d2p1:VossPlan>
<d2p1:VossPlanId>00000000-0000-0000-0000-000000000000</d2p1:VossPlanId>
</d2p1:LicensePlanQueryResponse>
</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>
</QueryResponseOfLicensePlanQueryResponseWg5EthtI>