BokaMera.API.Host

DeleteInactiveCompaniesRequest

The following routes are available for this service:
POST	/superadmin/company/inactive	Evaluates inactive companies and performs deletion or notification based on predefined criteria.

"use strict";
/** @typedef {'ActivityReminder'|'FinalWarning'|'Delete'} */
export var InactivityAction;
(function (InactivityAction) {
    InactivityAction["ActivityReminder"] = "ActivityReminder"
    InactivityAction["FinalWarning"] = "FinalWarning"
    InactivityAction["Delete"] = "Delete"
})(InactivityAction || (InactivityAction = {}));
export class InactiveCompanyResult {
    /** @param {{CompanyId?:string,LastActivityDate?:string,LastActivityNotificationDate?:string,DeletionTime?:string,Action?:InactivityAction}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    LastActivityDate;
    /** @type {string} */
    LastActivityNotificationDate;
    /** @type {string} */
    DeletionTime;
    /** @type {InactivityAction} */
    Action;
}
export class InactiveCompaniesResponse {
    /** @param {{ProcessedCompanies?:InactiveCompanyResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {InactiveCompanyResult[]} */
    ProcessedCompanies;
}
export class DeleteInactiveCompaniesRequest {
    /** @param {{BatchLimit?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Number of companies to process for deletion or notification in each run. */
    BatchLimit;
}

JavaScript DeleteInactiveCompaniesRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /superadmin/company/inactive HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"BatchLimit":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ProcessedCompanies":[{"Action":"ActivityReminder"}]}