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.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum InactivityAction : string
{
    case ActivityReminder = 'ActivityReminder';
    case FinalWarning = 'FinalWarning';
    case Delete = 'Delete';
}

class InactiveCompanyResult implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CompanyId='',
        /** @var DateTime */
        public DateTime $LastActivityDate=new DateTime(),
        /** @var DateTime */
        public DateTime $LastActivityNotificationDate=new DateTime(),
        /** @var DateTime */
        public DateTime $DeletionTime=new DateTime(),
        /** @var InactivityAction|null */
        public ?InactivityAction $Action=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['LastActivityDate'])) $this->LastActivityDate = JsonConverters::from('DateTime', $o['LastActivityDate']);
        if (isset($o['LastActivityNotificationDate'])) $this->LastActivityNotificationDate = JsonConverters::from('DateTime', $o['LastActivityNotificationDate']);
        if (isset($o['DeletionTime'])) $this->DeletionTime = JsonConverters::from('DateTime', $o['DeletionTime']);
        if (isset($o['Action'])) $this->Action = JsonConverters::from('InactivityAction', $o['Action']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->LastActivityDate)) $o['LastActivityDate'] = JsonConverters::to('DateTime', $this->LastActivityDate);
        if (isset($this->LastActivityNotificationDate)) $o['LastActivityNotificationDate'] = JsonConverters::to('DateTime', $this->LastActivityNotificationDate);
        if (isset($this->DeletionTime)) $o['DeletionTime'] = JsonConverters::to('DateTime', $this->DeletionTime);
        if (isset($this->Action)) $o['Action'] = JsonConverters::to('InactivityAction', $this->Action);
        return empty($o) ? new class(){} : $o;
    }
}

class InactiveCompaniesResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<InactiveCompanyResult>|null */
        public ?array $ProcessedCompanies=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ProcessedCompanies'])) $this->ProcessedCompanies = JsonConverters::fromArray('InactiveCompanyResult', $o['ProcessedCompanies']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ProcessedCompanies)) $o['ProcessedCompanies'] = JsonConverters::toArray('InactiveCompanyResult', $this->ProcessedCompanies);
        return empty($o) ? new class(){} : $o;
    }
}

class GetInactiveCompaniesReport implements JsonSerializable
{
    public function __construct(
        /** @var int|null */
        public ?int $Skip=null,
        /** @var int|null */
        public ?int $Take=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Skip'])) $this->Skip = $o['Skip'];
        if (isset($o['Take'])) $this->Take = $o['Take'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Skip)) $o['Skip'] = $this->Skip;
        if (isset($this->Take)) $o['Take'] = $this->Take;
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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>