| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /licenses/company/{Id} | Cancel a license to a company | Cancel an existing license to the company for the logged in user. The license will have it end date set to after it's period of notice. |
|---|
import 'package:servicestack/servicestack.dart';
class LicenseItemsResponse implements IConvertible
{
int? Id;
String? Name;
int? AllowedItems;
LicenseItemsResponse({this.Id,this.Name,this.AllowedItems});
LicenseItemsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
AllowedItems = json['AllowedItems'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'AllowedItems': AllowedItems
};
getTypeName() => "LicenseItemsResponse";
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 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 LicenseTypeQueryResponse implements IConvertible
{
/**
* The license type id
*/
// @ApiMember(Description="The license type id")
int? Id;
/**
* The license type name
*/
// @ApiMember(Description="The license type name")
String? Name;
/**
* The license type description
*/
// @ApiMember(Description="The license type description")
String? Description;
/**
* If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
*/
// @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
bool? IsExtraLicenseOption;
/**
* The period of notice for the license in days.
*/
// @ApiMember(Description="The period of notice for the license in days.")
int? PeriodOfNoticeDays;
/**
* The license items for the license type
*/
// @ApiMember(Description="The license items for the license type")
List<LicenseItemsResponse>? Items;
/**
* The license prices in each country for the license type
*/
// @ApiMember(Description="The license prices in each country for the license type")
List<LicensePrice>? Prices;
LicenseTypeQueryResponse({this.Id,this.Name,this.Description,this.IsExtraLicenseOption,this.PeriodOfNoticeDays,this.Items,this.Prices});
LicenseTypeQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Description = json['Description'];
IsExtraLicenseOption = json['IsExtraLicenseOption'];
PeriodOfNoticeDays = json['PeriodOfNoticeDays'];
Items = JsonConverters.fromJson(json['Items'],'List<LicenseItemsResponse>',context!);
Prices = JsonConverters.fromJson(json['Prices'],'List<LicensePrice>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Description': Description,
'IsExtraLicenseOption': IsExtraLicenseOption,
'PeriodOfNoticeDays': PeriodOfNoticeDays,
'Items': JsonConverters.toJson(Items,'List<LicenseItemsResponse>',context!),
'Prices': JsonConverters.toJson(Prices,'List<LicensePrice>',context!)
};
getTypeName() => "LicenseTypeQueryResponse";
TypeContext? context = _ctx;
}
class CompanyLicenseQueryResponse implements IConvertible
{
int? Id;
int? TypeId;
LicenseTypeQueryResponse? Type;
DateTime? ValidFrom;
DateTime? ValidTo;
String? MetaData;
bool? Active;
bool? Canceled;
DateTime? Updated;
DateTime? Created;
CompanyLicenseQueryResponse({this.Id,this.TypeId,this.Type,this.ValidFrom,this.ValidTo,this.MetaData,this.Active,this.Canceled,this.Updated,this.Created});
CompanyLicenseQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
TypeId = json['TypeId'];
Type = JsonConverters.fromJson(json['Type'],'LicenseTypeQueryResponse',context!);
ValidFrom = JsonConverters.fromJson(json['ValidFrom'],'DateTime',context!);
ValidTo = JsonConverters.fromJson(json['ValidTo'],'DateTime',context!);
MetaData = json['MetaData'];
Active = json['Active'];
Canceled = json['Canceled'];
Updated = JsonConverters.fromJson(json['Updated'],'DateTime',context!);
Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'TypeId': TypeId,
'Type': JsonConverters.toJson(Type,'LicenseTypeQueryResponse',context!),
'ValidFrom': JsonConverters.toJson(ValidFrom,'DateTime',context!),
'ValidTo': JsonConverters.toJson(ValidTo,'DateTime',context!),
'MetaData': MetaData,
'Active': Active,
'Canceled': Canceled,
'Updated': JsonConverters.toJson(Updated,'DateTime',context!),
'Created': JsonConverters.toJson(Created,'DateTime',context!)
};
getTypeName() => "CompanyLicenseQueryResponse";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CancelLicense implements ICompany, IConvertible
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
String? CompanyId;
/**
* Id of the license
*/
// @ApiMember(Description="Id of the license", IsRequired=true, ParameterType="path")
int? Id;
CancelLicense({this.CompanyId,this.Id});
CancelLicense.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Id': Id
};
getTypeName() => "CancelLicense";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
'LicenseItemsResponse': TypeInfo(TypeOf.Class, create:() => LicenseItemsResponse()),
'BaseModel': TypeInfo(TypeOf.Class, create:() => BaseModel()),
'Currency': TypeInfo(TypeOf.Class, create:() => Currency()),
'Country': TypeInfo(TypeOf.Class, create:() => Country()),
'LicensePrice': TypeInfo(TypeOf.Class, create:() => LicensePrice()),
'LicenseTypeQueryResponse': TypeInfo(TypeOf.Class, create:() => LicenseTypeQueryResponse()),
'List<LicenseItemsResponse>': TypeInfo(TypeOf.Class, create:() => <LicenseItemsResponse>[]),
'List<LicensePrice>': TypeInfo(TypeOf.Class, create:() => <LicensePrice>[]),
'CompanyLicenseQueryResponse': TypeInfo(TypeOf.Class, create:() => CompanyLicenseQueryResponse()),
'CancelLicense': TypeInfo(TypeOf.Class, create:() => CancelLicense()),
});
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.
DELETE /licenses/company/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CompanyLicenseQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<Canceled>false</Canceled>
<Created>0001-01-01T00:00:00</Created>
<Id>0</Id>
<MetaData>String</MetaData>
<Type>
<Description>String</Description>
<Id>0</Id>
<IsExtraLicenseOption>false</IsExtraLicenseOption>
<Items>
<LicenseItemsResponse>
<AllowedItems>0</AllowedItems>
<Id>0</Id>
<Name>String</Name>
</LicenseItemsResponse>
</Items>
<Name>String</Name>
<PeriodOfNoticeDays>0</PeriodOfNoticeDays>
<Prices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d3p1:LicensePrice>
<d3p1:Country>
<d3p1:Culture>String</d3p1:Culture>
<d3p1:CurrencyId>String</d3p1:CurrencyId>
<d3p1:CurrencyInfo>
<d3p1:Active>false</d3p1:Active>
<d3p1:CurrencySign>String</d3p1:CurrencySign>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
</d3p1:CurrencyInfo>
<d3p1:Id>String</d3p1:Id>
<d3p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Name>String</d3p1:Name>
<d3p1:TimeZone>String</d3p1:TimeZone>
</d3p1:Country>
<d3p1:CountryId>String</d3p1:CountryId>
<d3p1:LicenseTypeId>0</d3p1:LicenseTypeId>
<d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
<d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
<d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
</d3p1:ModifiedDate>
<d3p1:Price>0</d3p1:Price>
</d3p1:LicensePrice>
</Prices>
</Type>
<TypeId>0</TypeId>
<Updated>0001-01-01T00:00:00</Updated>
<ValidFrom>0001-01-01T00:00:00</ValidFrom>
<ValidTo>0001-01-01T00:00:00</ValidTo>
</CompanyLicenseQueryResponse>