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.

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

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class 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)]
        public virtual int? BatchLimit { get; set; }
    }

    public partial class InactiveCompaniesResponse
    {
        public InactiveCompaniesResponse()
        {
            ProcessedCompanies = new List<InactiveCompanyResult>{};
        }

        public virtual List<InactiveCompanyResult> ProcessedCompanies { get; set; }
    }

    public partial class InactiveCompanyResult
    {
        public virtual Guid CompanyId { get; set; }
        public virtual DateTime LastActivityDate { get; set; }
        public virtual DateTime LastActivityNotificationDate { get; set; }
        public virtual DateTime DeletionTime { get; set; }
        public virtual InactivityAction Action { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Helpers
{
    public enum InactivityAction
    {
        ActivityReminder,
        FinalWarning,
        Delete,
    }

}

C# 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>