BokaMera.API.Host

<back to all web services

CreateLicense

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/licenses/companyAdd new license to a companyAdd a new license to the company for the logged in user.
CreateLicense Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
TypeIdbodyint?YesId of the license type
MetaDatabodystringYesAny metadata connected to the license. In example for domain license set the requested domain name here.
BillingInformationbodyBillingInformationResponseNoIf you want to update your company billing information. Note, if no billing information is added before, you need to set this.
BillingInformationResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id.
BillingMethodIdformintYesThe prefered billing method.
NameformstringNoThe name that should be printed on the billing information, normally this would be your company name.
AttentionformstringNoIf you want to add the attention to the billing address.
Street1formstringNoThe street for the billing adress. This is required when having postal invoice as billing method.
Street2formstringNoThe street for the billing adress.
ZipCodeformstringNoThe zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
CityformstringNoThe city for the billing adress. This is required when having postal invoice as billing method.
CountryIdformstringNoThe country for the billing adress. This is required when having postal invoice as billing method.
EmailformstringNoThe billing email. This is required when having email invoice as billing method.
GLNformstringNoThe company global location number.
ReferenceLine1formstringNoYou're internal rereference.
ReferenceLine2formstringNoYou're internal rereference.
PaymentTermsDaysformintNoThe billing payment terms in days. This is default 15 days.
VatRegistrationNumberformstringNoThe company vat registration number.
BillingMethodOptionsformList<BillingMethod>NoThe billing method options to choose from
BillingMethod Parameters:
NameParameterData TypeRequiredDescription
BillingMethodCountriesRelationformList<BillingMethodCountriesRelation>No
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BillingMethodCountriesRelation Parameters:
NameParameterData TypeRequiredDescription
BillingMethodIdformintYes
CountryIdformstringYes
ModifiedDateformDateTimeOffset?No
CompanyLicenseQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TypeIdformintNo
TypeformLicenseTypeQueryResponseNo
ValidFromformDateTimeNo
ValidToformDateTimeNo
MetaDataformstringNo
ActiveformboolNo
CanceledformboolNo
UpdatedformDateTimeNo
CreatedformDateTimeNo
LicenseTypeQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe license type id
NameformstringNoThe license type name
DescriptionformstringNoThe license type description
IsExtraLicenseOptionformboolNoIf the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
PeriodOfNoticeDaysformintNoThe period of notice for the license in days.
ItemsformList<LicenseItemsResponse>NoThe license items for the license type
PricesformList<LicensePrice>NoThe license prices in each country for the license type
LicenseItemsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
AllowedItemsformintNo
LicensePrice Parameters:
NameParameterData TypeRequiredDescription
CountryformCountryNo
MonthlyPaymentformboolNo
LicenseTypeIdformintYes
CountryIdformstringYes
PriceformintYes
ModifiedDateformDateTimeOffset?No
Country Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
NameformstringYes
CultureformstringNo
TimeZoneformstringNo
ModifiedDateformDateTimeOffset?No
IdformstringYes
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrencySignformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + 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}