Billhighway Cloud API

CacheClearRq

The following routes are available for this service:
DELETE	/devops/api/caches/{location}


// @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 CacheClearResult extends CacheResultBase
{
    public IsCleared?: boolean;

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

export class CacheStat
{
    public Name?: string;
    public Value?: string;

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

export class CacheStatResult extends CacheResultBase
{
    public Statistics?: CacheStat[];
    public IsHit?: boolean;

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

export class CacheClearRs
{
    public Result?: CacheClearResult;
    public BeforeStatistics?: CacheStatResult;
    public AfterStatistics?: CacheStatResult;

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

export class CacheClearRq
{
    public location?: string;

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

TypeScript CacheClearRq 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} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CacheClearRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.DTO.Caching.Api.Response">
  <AfterStatistics 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>
    <d2p1:Statistics>
      <d2p1:CacheStat>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
      </d2p1:CacheStat>
    </d2p1:Statistics>
  </AfterStatistics>
  <BeforeStatistics 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>
    <d2p1:Statistics>
      <d2p1:CacheStat>
        <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
        <d2p1:_x003C_Value_x003E_k__BackingField>String</d2p1:_x003C_Value_x003E_k__BackingField>
      </d2p1:CacheStat>
    </d2p1:Statistics>
  </BeforeStatistics>
  <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>
</CacheClearRs>