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}

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

export enum CacheLocation
{
    None = 0,
    OutOfProcess = 1,
    InProcess = 2,
    InContext = 3,
}

export class CacheKey
{
    public Region?: string;
    public BaseKey?: string;
    public Key?: string;
    public ExpirationSeconds?: number;

    public constructor(init?: Partial<CacheKey>) { (Object as any).assign(this, init); }
}

export class CacheResultBase
{
    public Result?: CacheResult;
    public Location?: CacheLocation;
    public Key?: CacheKey;

    public constructor(init?: Partial<CacheResultBase>) { (Object as any).assign(this, init); }
}

export class CacheDeleteResult extends CacheResultBase
{
    public IsDeleted?: boolean;

    public constructor(init?: Partial<CacheDeleteResult>) { super(init); (Object as any).assign(this, init); }
}

export class CacheItemDeleteRs
{
    public Result?: CacheDeleteResult;

    public constructor(init?: Partial<CacheItemDeleteRs>) { (Object as any).assign(this, init); }
}

export class CacheItemDeleteRq
{
    public location?: string;
    public region?: string;
    public baseKey?: string;

    public constructor(init?: Partial<CacheItemDeleteRq>) { (Object as any).assign(this, init); }
}

TypeScript 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>