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.
"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 .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}