| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /licenses/company | Add new license to a company | Add a new license to the company for the logged in user. |
|---|
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;
}
class BillingMethodCountriesRelation extends BaseModel implements IConvertible
{
// @Required()
int? BillingMethodId;
// @Required()
String? CountryId;
DateTime? ModifiedDate;
BillingMethodCountriesRelation({this.BillingMethodId,this.CountryId,this.ModifiedDate});
BillingMethodCountriesRelation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
BillingMethodId = json['BillingMethodId'];
CountryId = json['CountryId'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'BillingMethodId': BillingMethodId,
'CountryId': CountryId,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!)
});
getTypeName() => "BillingMethodCountriesRelation";
TypeContext? context = _ctx;
}
class BillingMethod extends BaseModel implements IConvertible
{
List<BillingMethodCountriesRelation>? BillingMethodCountriesRelation;
// @Required()
String? Name;
// @Required()
String? Description;
DateTime? ModifiedDate;
int? Id;
BillingMethod({this.BillingMethodCountriesRelation,this.Name,this.Description,this.ModifiedDate,this.Id});
BillingMethod.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
BillingMethodCountriesRelation = JsonConverters.fromJson(json['BillingMethodCountriesRelation'],'List<BillingMethodCountriesRelation>',context!);
Name = json['Name'];
Description = json['Description'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
Id = json['Id'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'BillingMethodCountriesRelation': JsonConverters.toJson(BillingMethodCountriesRelation,'List<BillingMethodCountriesRelation>',context!),
'Name': Name,
'Description': Description,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'Id': Id
});
getTypeName() => "BillingMethod";
TypeContext? context = _ctx;
}
class BillingInformationResponse implements IConvertible
{
/**
* The company id.
*/
// @ApiMember(Description="The company id.")
String? CompanyId;
/**
* The prefered billing method.
*/
// @ApiMember(Description="The prefered billing method.", IsRequired=true)
int? BillingMethodId;
/**
* The name that should be printed on the billing information, normally this would be your company name.
*/
// @ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")
String? Name;
/**
* If you want to add the attention to the billing address.
*/
// @ApiMember(Description="If you want to add the attention to the billing address.")
String? Attention;
/**
* The street for the billing adress. This is required when having postal invoice as billing method.
*/
// @ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")
String? Street1;
/**
* The street for the billing adress.
*/
// @ApiMember(Description="The street for the billing adress.")
String? Street2;
/**
* The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
*/
// @ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")
String? ZipCode;
/**
* The city for the billing adress. This is required when having postal invoice as billing method.
*/
// @ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")
String? City;
/**
* The country for the billing adress. This is required when having postal invoice as billing method.
*/
// @ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")
String? CountryId;
/**
* The billing email. This is required when having email invoice as billing method.
*/
// @ApiMember(Description="The billing email. This is required when having email invoice as billing method.")
String? Email;
/**
* The company global location number.
*/
// @ApiMember(Description="The company global location number.")
String? GLN;
/**
* You're internal rereference.
*/
// @ApiMember(Description="You're internal rereference.")
String? ReferenceLine1;
/**
* You're internal rereference.
*/
// @ApiMember(Description="You're internal rereference.")
String? ReferenceLine2;
/**
* The billing payment terms in days. This is default 15 days.
*/
// @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
int? PaymentTermsDays;
/**
* The company vat registration number.
*/
// @ApiMember(Description="The company vat registration number.")
String? VatRegistrationNumber;
/**
* The billing method options to choose from
*/
// @ApiMember(Description="The billing method options to choose from")
List<BillingMethod>? BillingMethodOptions;
BillingInformationResponse({this.CompanyId,this.BillingMethodId,this.Name,this.Attention,this.Street1,this.Street2,this.ZipCode,this.City,this.CountryId,this.Email,this.GLN,this.ReferenceLine1,this.ReferenceLine2,this.PaymentTermsDays,this.VatRegistrationNumber,this.BillingMethodOptions});
BillingInformationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
BillingMethodId = json['BillingMethodId'];
Name = json['Name'];
Attention = json['Attention'];
Street1 = json['Street1'];
Street2 = json['Street2'];
ZipCode = json['ZipCode'];
City = json['City'];
CountryId = json['CountryId'];
Email = json['Email'];
GLN = json['GLN'];
ReferenceLine1 = json['ReferenceLine1'];
ReferenceLine2 = json['ReferenceLine2'];
PaymentTermsDays = json['PaymentTermsDays'];
VatRegistrationNumber = json['VatRegistrationNumber'];
BillingMethodOptions = JsonConverters.fromJson(json['BillingMethodOptions'],'List<BillingMethod>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'BillingMethodId': BillingMethodId,
'Name': Name,
'Attention': Attention,
'Street1': Street1,
'Street2': Street2,
'ZipCode': ZipCode,
'City': City,
'CountryId': CountryId,
'Email': Email,
'GLN': GLN,
'ReferenceLine1': ReferenceLine1,
'ReferenceLine2': ReferenceLine2,
'PaymentTermsDays': PaymentTermsDays,
'VatRegistrationNumber': VatRegistrationNumber,
'BillingMethodOptions': JsonConverters.toJson(BillingMethodOptions,'List<BillingMethod>',context!)
};
getTypeName() => "BillingInformationResponse";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CreateLicense 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 type
*/
// @ApiMember(Description="Id of the license type", IsRequired=true)
int? TypeId;
/**
* Any metadata connected to the license. In example for domain license set the requested domain name here.
*/
// @ApiMember(Description="Any metadata connected to the license. In example for domain license set the requested domain name here.", IsRequired=true)
String? MetaData;
/**
* If you want to update your company billing information. Note, if no billing information is added before, you need to set this.
*/
// @ApiMember(Description="If you want to update your company billing information. Note, if no billing information is added before, you need to set this.")
BillingInformationResponse? BillingInformation;
CreateLicense({this.CompanyId,this.TypeId,this.MetaData,this.BillingInformation});
CreateLicense.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
TypeId = json['TypeId'];
MetaData = json['MetaData'];
BillingInformation = JsonConverters.fromJson(json['BillingInformation'],'BillingInformationResponse',context!);
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'TypeId': TypeId,
'MetaData': MetaData,
'BillingInformation': JsonConverters.toJson(BillingInformation,'BillingInformationResponse',context!)
};
getTypeName() => "CreateLicense";
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()),
'BillingMethodCountriesRelation': TypeInfo(TypeOf.Class, create:() => BillingMethodCountriesRelation()),
'BillingMethod': TypeInfo(TypeOf.Class, create:() => BillingMethod()),
'List<BillingMethodCountriesRelation>': TypeInfo(TypeOf.Class, create:() => <BillingMethodCountriesRelation>[]),
'BillingInformationResponse': TypeInfo(TypeOf.Class, create:() => BillingInformationResponse()),
'List<BillingMethod>': TypeInfo(TypeOf.Class, create:() => <BillingMethod>[]),
'CreateLicense': TypeInfo(TypeOf.Class, create:() => CreateLicense()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /licenses/company HTTP/1.1
Host: api.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","TypeId":0,"MetaData":"String","BillingInformation":{"BillingMethodId":0,"Name":"String","Attention":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Email":"String","GLN":"String","ReferenceLine1":"String","ReferenceLine2":"String","PaymentTermsDays":0,"VatRegistrationNumber":"String","BillingMethodOptions":[{"BillingMethodCountriesRelation":[{"BillingMethodId":0,"CountryId":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}],"Name":"String","Description":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":0}]}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Id":0,"TypeId":0,"Type":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]},"MetaData":"String","Active":false,"Canceled":false}