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.

"use strict";
export class LicenseItemsResponse {
    /** @param {{Id?:number,Name?:string,AllowedItems?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {number} */
    AllowedItems;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class Currency extends BaseModel {
    /** @param {{Name?:string,CurrencySign?:string,Active?:boolean,ModifiedDate?:string,Id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    CurrencySign;
    /** @type {boolean} */
    Active;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    Id;
}
export class Country extends BaseModel {
    /** @param {{CurrencyId?:string,CurrencyInfo?:Currency,Name?:string,Culture?:string,TimeZone?:string,ModifiedDate?:string,Id?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    CurrencyId;
    /** @type {Currency} */
    CurrencyInfo;
    /** @type {string} */
    Name;
    /** @type {string} */
    Culture;
    /** @type {string} */
    TimeZone;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    Id;
}
export class LicensePrice extends BaseModel {
    /** @param {{Country?:Country,MonthlyPayment?:boolean,LicenseTypeId?:number,CountryId?:string,Price?:number,ModifiedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {Country} */
    Country;
    /** @type {boolean} */
    MonthlyPayment;
    /** @type {number} */
    LicenseTypeId;
    /** @type {string} */
    CountryId;
    /** @type {number} */
    Price;
    /** @type {?string} */
    ModifiedDate;
}
export class LicenseTypeQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,IsExtraLicenseOption?:boolean,PeriodOfNoticeDays?:number,Items?:LicenseItemsResponse[],Prices?:LicensePrice[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The license type id */
    Id;
    /**
     * @type {string}
     * @description The license type name */
    Name;
    /**
     * @type {string}
     * @description The license type description */
    Description;
    /**
     * @type {boolean}
     * @description If the license type is not a standard license but instead an extra license option. An example would be sending new letter license. */
    IsExtraLicenseOption;
    /**
     * @type {number}
     * @description The period of notice for the license in days. */
    PeriodOfNoticeDays;
    /**
     * @type {LicenseItemsResponse[]}
     * @description The license items for the license type */
    Items;
    /**
     * @type {LicensePrice[]}
     * @description The license prices in each country for the license type */
    Prices;
}
export class CompanyLicenseQueryResponse {
    /** @param {{Id?:number,TypeId?:number,Type?:LicenseTypeQueryResponse,ValidFrom?:string,ValidTo?:string,MetaData?:string,Active?:boolean,Canceled?:boolean,Updated?:string,Created?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TypeId;
    /** @type {LicenseTypeQueryResponse} */
    Type;
    /** @type {string} */
    ValidFrom;
    /** @type {string} */
    ValidTo;
    /** @type {string} */
    MetaData;
    /** @type {boolean} */
    Active;
    /** @type {boolean} */
    Canceled;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
}
export class BillingMethodCountriesRelation extends BaseModel {
    /** @param {{BillingMethodId?:number,CountryId?:string,ModifiedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    BillingMethodId;
    /** @type {string} */
    CountryId;
    /** @type {?string} */
    ModifiedDate;
}
export class BillingMethod extends BaseModel {
    /** @param {{BillingMethodCountriesRelation?:BillingMethodCountriesRelation[],Name?:string,Description?:string,ModifiedDate?:string,Id?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {BillingMethodCountriesRelation[]} */
    BillingMethodCountriesRelation;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {?string} */
    ModifiedDate;
    /** @type {number} */
    Id;
}
export class BillingInformationResponse {
    /** @param {{CompanyId?:string,BillingMethodId?:number,Name?:string,Attention?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,CountryId?:string,Email?:string,GLN?:string,ReferenceLine1?:string,ReferenceLine2?:string,PaymentTermsDays?:number,VatRegistrationNumber?:string,BillingMethodOptions?:BillingMethod[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {number}
     * @description The prefered billing method. */
    BillingMethodId;
    /**
     * @type {string}
     * @description The name that should be printed on the billing information, normally this would be your company name. */
    Name;
    /**
     * @type {string}
     * @description If you want to add the attention to the billing address. */
    Attention;
    /**
     * @type {string}
     * @description The street for the billing adress. This is required when having postal invoice as billing method. */
    Street1;
    /**
     * @type {string}
     * @description The street for the billing adress. */
    Street2;
    /**
     * @type {string}
     * @description The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method. */
    ZipCode;
    /**
     * @type {string}
     * @description The city for the billing adress. This is required when having postal invoice as billing method. */
    City;
    /**
     * @type {string}
     * @description The country for the billing adress. This is required when having postal invoice as billing method. */
    CountryId;
    /**
     * @type {string}
     * @description The billing email. This is required when having email invoice as billing method. */
    Email;
    /**
     * @type {string}
     * @description The company global location number. */
    GLN;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine1;
    /**
     * @type {string}
     * @description You're internal rereference. */
    ReferenceLine2;
    /**
     * @type {number}
     * @description The billing payment terms in days. This is default 15 days. */
    PaymentTermsDays;
    /**
     * @type {string}
     * @description The company vat registration number. */
    VatRegistrationNumber;
    /**
     * @type {BillingMethod[]}
     * @description The billing method options to choose from */
    BillingMethodOptions;
}
export class CreateLicense {
    /** @param {{CompanyId?:string,TypeId?:number,MetaData?:string,BillingInformation?:BillingInformationResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description Id of the license type */
    TypeId;
    /**
     * @type {string}
     * @description Any metadata connected to the license. In example for domain license set the requested domain name here. */
    MetaData;
    /**
     * @type {BillingInformationResponse}
     * @description If you want to update your company billing information. Note, if no billing information is added before, you need to set this. */
    BillingInformation;
}

JavaScript CreateLicense DTOs

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: api.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>
    <GLN>String</GLN>
    <Name>String</Name>
    <PaymentTermsDays>0</PaymentTermsDays>
    <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>