BokaMera.API.Host

GetInactiveCompaniesReport

**Requires Authentication**
Required role:	superadmin

The following routes are available for this service:
GET	/superadmin/company/inactive/report	Retrieves a report of inactive companies with their status.	This endpoint does not modify any data.

"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 GetInactiveCompaniesReport {
    /** @param {{Skip?:number,Take?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Skip;
    /** @type {?number} */
    Take;
}

JavaScript GetInactiveCompaniesReport 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.

GET /superadmin/company/inactive/report HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<InactiveCompaniesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ProcessedCompanies>
    <InactiveCompanyResult>
      <Action>ActivityReminder</Action>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <DeletionTime>0001-01-01T00:00:00</DeletionTime>
      <LastActivityDate>0001-01-01T00:00:00</LastActivityDate>
      <LastActivityNotificationDate>0001-01-01T00:00:00</LastActivityNotificationDate>
    </InactiveCompanyResult>
  </ProcessedCompanies>
</InactiveCompaniesResponse>