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.

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Helpers

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class GetInactiveCompaniesReport
            Public Overridable Property Skip As Nullable(Of Integer)
            Public Overridable Property Take As Nullable(Of Integer)
        End Class

        Public Partial Class InactiveCompaniesResponse
            Public Sub New()
                ProcessedCompanies = New List(Of InactiveCompanyResult)
            End Sub

            Public Overridable Property ProcessedCompanies As List(Of InactiveCompanyResult)
        End Class

        Public Partial Class InactiveCompanyResult
            Public Overridable Property CompanyId As Guid
            Public Overridable Property LastActivityDate As Date
            Public Overridable Property LastActivityNotificationDate As Date
            Public Overridable Property DeletionTime As Date
            Public Overridable Property Action As InactivityAction
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Helpers

        Public Enum InactivityAction
            ActivityReminder
            FinalWarning
            Delete
        End Enum
    End Namespace
End Namespace

VB.NET 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: api.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>