BokaMera.API.Host

CreateLicense

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/licenses/company	Add new license to a company	Add a new license to the company for the logged in user.

**CreateLicense** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
TypeId	body	int?	Yes	Id of the license type
MetaData	body	string	Yes	Any metadata connected to the license. In example for domain license set the requested domain name here.
BillingInformation	body	BillingInformationResponse	Yes	If you want to update your company billing information. Note, if no billing information is added before, you need to set this.

**BillingInformationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No	The company id.
BillingMethodId	form	int	Yes	The prefered billing method.
Name	form	string	Yes	The name that should be printed on the billing information, normally this would be your company name.
FirstName	form	string	Yes	Billing person first name
LastName	form	string	Yes	Billing person last name
PhoneNumber	form	string	Yes	Billing person phone numbers
Attention	form	string	Yes	If you want to add the attention to the billing address.
Street1	form	string	Yes	The street for the billing adress. This is required when having postal invoice as billing method.
Street2	form	string	Yes	The street for the billing adress.
ZipCode	form	string	Yes	The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
City	form	string	Yes	The city for the billing adress. This is required when having postal invoice as billing method.
CountryId	form	string	Yes	The country for the billing adress. This is required when having postal invoice as billing method.
Email	form	string	Yes	The billing email. This is required when having email invoice as billing method.
GLN	form	string	Yes	The company global location number.
ReferenceLine1	form	string	Yes	Your internal reference.
ReferenceLine2	form	string	Yes	Your internal reference.
PaymentTermsDays	form	int	No	The billing payment terms in days. This is default 15 days.
VatRegistrationNumber	form	string	Yes	The company vat registration number.
BillingMethodOptions	form	List<BillingMethod>	Yes	The billing method options to choose from

**BillingMethod** Parameters:
Name	Parameter	Data Type	Required
BillingMethodCountriesRelation	form	List<BillingMethodCountriesRelation>	Yes
Name	form	string	Yes
Description	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	int	No

**BillingMethodCountriesRelation** Parameters:
Name	Parameter	Data Type	Required
BillingMethodId	form	int	Yes
CountryId	form	string	Yes
ModifiedDate	form	DateTimeOffset?	No

**CompanyLicenseQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
TypeId	form	int	No
Type	form	LicenseTypeQueryResponse	Yes
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No
MetaData	form	string	Yes
Active	form	bool	No
Canceled	form	bool	No
Updated	form	DateTime	No
Created	form	DateTime	No

**LicenseTypeQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The license type id
Name	form	string	Yes	The license type name
Description	form	string	Yes	The license type description
IsExtraLicenseOption	form	bool	No	If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.
PeriodOfNoticeDays	form	int	No	The period of notice for the license in days.
Items	form	List<LicenseItemsResponse>	Yes	The license items for the license type
Prices	form	List<LicensePrice>	Yes	The license prices in each country for the license type

**LicenseItemsResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
AllowedItems	form	int	No

**LicensePrice** Parameters:
Name	Parameter	Data Type	Required
Country	form	Country	Yes
MonthlyPayment	form	bool	No
LicenseTypeId	form	int	Yes
CountryId	form	string	Yes
Price	form	int	Yes
ModifiedDate	form	DateTimeOffset?	No

**Country** Parameters:
Name	Parameter	Data Type	Required
CurrencyId	form	string	Yes
CurrencyInfo	form	Currency	Yes
Name	form	string	Yes
Culture	form	string	No
TimeZone	form	string	No
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

**Currency** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	Yes
CurrencySign	form	string	Yes
Active	form	bool	Yes
ModifiedDate	form	DateTimeOffset?	No
Id	form	string	Yes

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

HTTP + XML

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: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateLicense xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BillingInformation>
    <Attention>String</Attention>
    <BillingMethodId>0</BillingMethodId>
    <BillingMethodOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:BillingMethod>
        <d3p1:BillingMethodCountriesRelation>
          <d3p1:BillingMethodCountriesRelation>
            <d3p1:BillingMethodId>0</d3p1:BillingMethodId>
            <d3p1:CountryId>String</d3p1:CountryId>
            <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:BillingMethodCountriesRelation>
        </d3p1:BillingMethodCountriesRelation>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <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:Name>String</d3p1:Name>
      </d3p1:BillingMethod>
    </BillingMethodOptions>
    <City>String</City>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CountryId>String</CountryId>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <GLN>String</GLN>
    <LastName>String</LastName>
    <Name>String</Name>
    <PaymentTermsDays>0</PaymentTermsDays>
    <PhoneNumber>String</PhoneNumber>
    <ReferenceLine1>String</ReferenceLine1>
    <ReferenceLine2>String</ReferenceLine2>
    <Street1>String</Street1>
    <Street2>String</Street2>
    <VatRegistrationNumber>String</VatRegistrationNumber>
    <ZipCode>String</ZipCode>
  </BillingInformation>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <MetaData>String</MetaData>
  <TypeId>0</TypeId>
</CreateLicense>

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>