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.

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


open class DeleteInactiveCompaniesRequest
{
    /**
    * 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)
    var BatchLimit:Int? = null
}

open class InactiveCompaniesResponse
{
    var ProcessedCompanies:ArrayList<InactiveCompanyResult> = ArrayList<InactiveCompanyResult>()
}

open class InactiveCompanyResult
{
    var CompanyId:UUID? = null
    var LastActivityDate:Date? = null
    var LastActivityNotificationDate:Date? = null
    var DeletionTime:Date? = null
    var Action:InactivityAction? = null
}

enum class InactivityAction
{
    ActivityReminder,
    FinalWarning,
    Delete,
}

Kotlin DeleteInactiveCompaniesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BatchLimit: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ProcessedCompanies: 
	[
		{
			Action: ActivityReminder
		}
	]
}