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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type InactivityAction =
        | ActivityReminder = 0
        | FinalWarning = 1
        | Delete = 2

    [<AllowNullLiteral>]
    type InactiveCompanyResult() = 
        member val CompanyId:Guid = new Guid() with get,set
        member val LastActivityDate:DateTime = new DateTime() with get,set
        member val LastActivityNotificationDate:DateTime = new DateTime() with get,set
        member val DeletionTime:DateTime = new DateTime() with get,set
        member val Action:InactivityAction = new InactivityAction() with get,set

    [<AllowNullLiteral>]
    type InactiveCompaniesResponse() = 
        member val ProcessedCompanies:ResizeArray<InactiveCompanyResult> = new ResizeArray<InactiveCompanyResult>() with get,set

    [<AllowNullLiteral>]
    type GetInactiveCompaniesReport() = 
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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"}]}