| 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. |
|---|
export class LicenseItemsResponse
{
public Id: number;
public Name: string;
public AllowedItems: number;
public constructor(init?: Partial<LicenseItemsResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class Currency extends BaseModel
{
// @Required()
public Name: string;
// @Required()
public CurrencySign: string;
// @Required()
public Active: boolean;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Currency>) { super(init); (Object as any).assign(this, init); }
}
export class Country extends BaseModel
{
// @References("typeof(BokaMera.API.ServiceModel.Db.Currency)")
public CurrencyId: string;
public CurrencyInfo: Currency;
// @Required()
public Name: string;
public Culture: string;
public TimeZone: string;
public ModifiedDate?: string;
// @Required()
public Id: string;
public constructor(init?: Partial<Country>) { super(init); (Object as any).assign(this, init); }
}
export class LicensePrice extends BaseModel
{
// @Ignore()
public Country: Country;
// @Ignore()
public MonthlyPayment: boolean;
// @Required()
public LicenseTypeId: number;
// @Required()
public CountryId: string;
// @Required()
public Price: number;
public ModifiedDate?: string;
public constructor(init?: Partial<LicensePrice>) { super(init); (Object as any).assign(this, init); }
}
export class LicenseTypeQueryResponse
{
/** @description The license type id */
// @ApiMember(Description="The license type id")
public Id: number;
/** @description The license type name */
// @ApiMember(Description="The license type name")
public Name: string;
/** @description The license type description */
// @ApiMember(Description="The license type description")
public 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.")
public IsExtraLicenseOption: boolean;
/** @description The period of notice for the license in days. */
// @ApiMember(Description="The period of notice for the license in days.")
public PeriodOfNoticeDays: number;
/** @description The license items for the license type */
// @ApiMember(Description="The license items for the license type")
public Items: LicenseItemsResponse[];
/** @description The license prices in each country for the license type */
// @ApiMember(Description="The license prices in each country for the license type")
public Prices: LicensePrice[];
public constructor(init?: Partial<LicenseTypeQueryResponse>) { (Object as any).assign(this, init); }
}
export class CompanyLicenseQueryResponse
{
public Id: number;
public TypeId: number;
public Type: LicenseTypeQueryResponse;
public ValidFrom: string;
public ValidTo: string;
public MetaData: string;
public Active: boolean;
public Canceled: boolean;
public Updated: string;
public Created: string;
public constructor(init?: Partial<CompanyLicenseQueryResponse>) { (Object as any).assign(this, init); }
}
export class BillingMethodCountriesRelation extends BaseModel
{
// @Required()
public BillingMethodId: number;
// @Required()
public CountryId: string;
public ModifiedDate?: string;
public constructor(init?: Partial<BillingMethodCountriesRelation>) { super(init); (Object as any).assign(this, init); }
}
export class BillingMethod extends BaseModel
{
public BillingMethodCountriesRelation: BillingMethodCountriesRelation[];
// @Required()
public Name: string;
// @Required()
public Description: string;
public ModifiedDate?: string;
public Id: number;
public constructor(init?: Partial<BillingMethod>) { super(init); (Object as any).assign(this, init); }
}
export class BillingInformationResponse
{
/** @description The company id. */
// @ApiMember(Description="The company id.")
public CompanyId: string;
/** @description The prefered billing method. */
// @ApiMember(Description="The prefered billing method.", IsRequired=true)
public BillingMethodId: number;
/** @description 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.")
public Name: string;
/** @description If you want to add the attention to the billing address. */
// @ApiMember(Description="If you want to add the attention to the billing address.")
public Attention: string;
/** @description 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.")
public Street1: string;
/** @description The street for the billing adress. */
// @ApiMember(Description="The street for the billing adress.")
public Street2: string;
/** @description 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.")
public ZipCode: string;
/** @description 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.")
public City: string;
/** @description 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.")
public CountryId: string;
/** @description 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.")
public Email: string;
/** @description The company global location number. */
// @ApiMember(Description="The company global location number.")
public GLN: string;
/** @description You're internal rereference. */
// @ApiMember(Description="You're internal rereference.")
public ReferenceLine1: string;
/** @description You're internal rereference. */
// @ApiMember(Description="You're internal rereference.")
public ReferenceLine2: string;
/** @description The billing payment terms in days. This is default 15 days. */
// @ApiMember(Description="The billing payment terms in days. This is default 15 days.")
public PaymentTermsDays: number;
/** @description The company vat registration number. */
// @ApiMember(Description="The company vat registration number.")
public VatRegistrationNumber: string;
/** @description The billing method options to choose from */
// @ApiMember(Description="The billing method options to choose from")
public BillingMethodOptions: BillingMethod[];
public constructor(init?: Partial<BillingInformationResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateLicense implements ICompany
{
/** @description 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.")
public CompanyId?: string;
/** @description Id of the license type */
// @ApiMember(Description="Id of the license type", IsRequired=true)
public TypeId: number;
/** @description 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)
public MetaData: string;
/** @description 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.")
public BillingInformation: BillingInformationResponse;
public constructor(init?: Partial<CreateLicense>) { (Object as any).assign(this, init); }
}
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.
POST /licenses/company HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
}