BokaMera.API.Host

<back to all web services

DeleteCustomerSuperAdminUser

Requires Authentication
Required role:superadmin
The following routes are available for this service:
DELETE/superadmin/company/{Id}Deletes a customer and everything realted to customer, including administrators and bookings etc.
"use strict";
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class LicenseTypeItem extends BaseModel {
    /** @param {{Name?:string,LicenseTypesId?:number,LicenseItemsId?:number,NumberOfItems?:number,Id?:number,ModifiedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {number} */
    LicenseTypesId;
    /** @type {number} */
    LicenseItemsId;
    /** @type {number} */
    NumberOfItems;
    /** @type {number} */
    Id;
    /** @type {?string} */
    ModifiedDate;
}
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 LicenseType extends BaseModel {
    /** @param {{LicenseItems?:IList<LicenseTypeItem>,Prices?:IList<LicensePrice>,PeriodOfNoticeDays?:number,NextLicenseOption?:LicenseType,Name?:string,Description?:string,ExtraLicenseOption?:boolean,ModifiedDate?:string,Id?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {IList<LicenseTypeItem>} */
    LicenseItems;
    /** @type {IList<LicensePrice>} */
    Prices;
    /** @type {number} */
    PeriodOfNoticeDays;
    /** @type {LicenseType} */
    NextLicenseOption;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    ExtraLicenseOption;
    /** @type {?string} */
    ModifiedDate;
    /** @type {number} */
    Id;
}
export class License extends BaseModel {
    /** @param {{Type?:LicenseType,CompanyId?:string,Id?:number,TypeId?:number,ValidFrom?:string,ValidTo?:string,Active?:boolean,Updated?:string,Created?:string,ModifiedDate?:string,MetaData?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {LicenseType} */
    Type;
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {number} */
    TypeId;
    /** @type {string} */
    ValidFrom;
    /** @type {string} */
    ValidTo;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    MetaData;
}
export class DeletedCustomerInfoResponse {
    /** @param {{CompanyId?:string,ActiveLicenses?:License[],Comment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    CompanyId;
    /** @type {License[]} */
    ActiveLicenses;
    /** @type {string} */
    Comment;
}
export class DeleteCustomerSuperAdminUser {
    /** @param {{CompanyId?:string,Id?:string,GotApprovedByAdmin?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Enter the companyId for the customer */
    CompanyId;
    /**
     * @type {string}
     * @description Id (guid) of company you wish to delete. */
    Id;
    /** @type {boolean} */
    GotApprovedByAdmin;
}

JavaScript DeleteCustomerSuperAdminUser 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 /superadmin/company/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'DeletedCustomerInfoResponse' using the custom 'other' filter}One or more errors occurred. (License type not handled in NextLicenseOption)