BokaMera.API.Host

CancelLicense

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

The following routes are available for this service:
DELETE	/licenses/company/{Id}	Cancel a license to a company	Cancel an existing license to the company for the logged in user. The license will have it end date set to after it's period of notice.

"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 CancelLicense {
    /** @param {{CompanyId?:string,Id?:number}} [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 */
    Id;
}

JavaScript CancelLicense DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /licenses/company/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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}