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.


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 DeleteInactiveCompaniesRequest
{
    /** @description Number of companies to process for deletion or notification in each run. */
    // @ApiMember(Description="Number of companies to process for deletion or notification in each run.", IsRequired=true)
    public BatchLimit: number;

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

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

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

<DeleteInactiveCompaniesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BatchLimit>0</BatchLimit>
</DeleteInactiveCompaniesRequest>

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>