BokaMera.API.Host

<back to all web services

GetInactiveCompaniesReport

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

export enum InactivityAction
{
    ActivityReminder = 'ActivityReminder',
    FinalWarning = 'FinalWarning',
    Delete = 'Delete',
}

export class InactiveCompanyResult
{
    public CompanyId: string;
    public LastActivityDate: string;
    public LastActivityNotificationDate: string;
    public DeletionTime: string;
    public Action: InactivityAction;

    public constructor(init?: Partial<InactiveCompanyResult>) { (Object as any).assign(this, init); }
}

export class InactiveCompaniesResponse
{
    public ProcessedCompanies: InactiveCompanyResult[];

    public constructor(init?: Partial<InactiveCompaniesResponse>) { (Object as any).assign(this, init); }
}

export class GetInactiveCompaniesReport
{
    public Skip?: number;
    public Take?: number;

    public constructor(init?: Partial<GetInactiveCompaniesReport>) { (Object as any).assign(this, init); }
}

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

GET /superadmin/company/inactive/report HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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