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.

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GetInactiveCompaniesReport
    {
        public Integer Skip = null;
        public Integer Take = null;
        
        public Integer getSkip() { return Skip; }
        public GetInactiveCompaniesReport setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public GetInactiveCompaniesReport setTake(Integer value) { this.Take = value; return this; }
    }

    public static class InactiveCompaniesResponse
    {
        public ArrayList<InactiveCompanyResult> ProcessedCompanies = null;
        
        public ArrayList<InactiveCompanyResult> getProcessedCompanies() { return ProcessedCompanies; }
        public InactiveCompaniesResponse setProcessedCompanies(ArrayList<InactiveCompanyResult> value) { this.ProcessedCompanies = value; return this; }
    }

    public static class InactiveCompanyResult
    {
        public UUID CompanyId = null;
        public Date LastActivityDate = null;
        public Date LastActivityNotificationDate = null;
        public Date DeletionTime = null;
        public InactivityAction Action = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public InactiveCompanyResult setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Date getLastActivityDate() { return LastActivityDate; }
        public InactiveCompanyResult setLastActivityDate(Date value) { this.LastActivityDate = value; return this; }
        public Date getLastActivityNotificationDate() { return LastActivityNotificationDate; }
        public InactiveCompanyResult setLastActivityNotificationDate(Date value) { this.LastActivityNotificationDate = value; return this; }
        public Date getDeletionTime() { return DeletionTime; }
        public InactiveCompanyResult setDeletionTime(Date value) { this.DeletionTime = value; return this; }
        public InactivityAction getAction() { return Action; }
        public InactiveCompanyResult setAction(InactivityAction value) { this.Action = value; return this; }
    }

    public static enum InactivityAction
    {
        ActivityReminder,
        FinalWarning,
        Delete;
    }

}

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