Billhighway Cloud API

<back to all web services

CacheItemDeleteRq

The following routes are available for this service:
DELETE/devops/api/caches/{location}/regions/{region}/keys/{basekey}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class CacheItemDeleteRq
{
    var location:String? = null
    var region:String? = null
    var baseKey:String? = null
}

open class CacheItemDeleteRs
{
    var Result:CacheDeleteResult? = null
}

open class CacheDeleteResult : CacheResultBase()
{
    var IsDeleted:Boolean? = null
}

open class CacheResultBase
{
    var Result:CacheResult? = null
    var Location:CacheLocation? = null
    var Key:CacheKey? = null
}

@Flags()
enum class CacheResult(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Miss(1),
    @SerializedName("2") Hit(2),
    @SerializedName("4") Put(4),
    @SerializedName("8") Deleted(8),
    @SerializedName("16") Cleared(16),
    @SerializedName("32") Added(32),
    @SerializedName("64") Updated(64),
    @SerializedName("128") Unavailable(128),
    @SerializedName("256") Expired(256),
}

enum class CacheLocation(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") OutOfProcess(1),
    @SerializedName("2") InProcess(2),
    @SerializedName("3") InContext(3),
}

open class CacheKey
{
    var Region:String? = null
    var BaseKey:String? = null
    var Key:String? = null
    var ExpirationSeconds:Int? = null
}

Kotlin CacheItemDeleteRq 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.

DELETE /devops/api/caches/{location}/regions/{region}/keys/{basekey} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CacheItemDeleteRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Caching.Api.Response">
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Caching">
    <d2p1:Key i:nil="true" />
    <d2p1:Location>None</d2p1:Location>
    <d2p1:Result>None</d2p1:Result>
  </Result>
</CacheItemDeleteRs>