BokaMera.API.Host

<back to all web services

DeleteInactiveCompaniesRequest

The following routes are available for this service:
POST/superadmin/company/inactiveEvaluates inactive companies and performs deletion or notification based on predefined criteria.
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 DeleteInactiveCompaniesRequest() = 
        ///<summary>
        ///Number of companies to process for deletion or notification in each run.
        ///</summary>
        [<ApiMember(Description="Number of companies to process for deletion or notification in each run.", IsRequired=true)>]
        member val BatchLimit:Nullable<Int32> = new Nullable<Int32>() with get,set

F# DeleteInactiveCompaniesRequest 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.

POST /superadmin/company/inactive HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DeleteInactiveCompaniesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BatchLimit>0</BatchLimit>
</DeleteInactiveCompaniesRequest>

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>