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 Foundation
import ServiceStack

public class CacheItemDeleteRq : Codable
{
    public var location:String?
    public var region:String?
    public var baseKey:String?

    required public init(){}
}

public class CacheItemDeleteRs : Codable
{
    public var result:CacheDeleteResult?

    required public init(){}
}

public class CacheDeleteResult : CacheResultBase
{
    public var isDeleted:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case isDeleted
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        isDeleted = try container.decodeIfPresent(Bool.self, forKey: .isDeleted)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if isDeleted != nil { try container.encode(isDeleted, forKey: .isDeleted) }
    }
}

public class CacheResultBase : Codable
{
    public var result:CacheResult?
    public var location:CacheLocation?
    public var key:CacheKey?

    required public init(){}
}

// @Flags()
public enum CacheResult : Int, Codable
{
    case None = 0
    case Miss = 1
    case Hit = 2
    case Put = 4
    case Deleted = 8
    case Cleared = 16
    case Added = 32
    case Updated = 64
    case Unavailable = 128
    case Expired = 256
}

public enum CacheLocation : Int, Codable
{
    case None = 0
    case OutOfProcess = 1
    case InProcess = 2
    case InContext = 3
}

public class CacheKey : Codable
{
    public var region:String?
    public var baseKey:String?
    public var key:String?
    public var expirationSeconds:Int?

    required public init(){}
}


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

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

{"Result":{"IsDeleted":false,"Result":0,"Location":0}}