Billhighway Cloud API

CacheClearRq

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

**CacheClearRq** Parameters:
Name	Parameter	Data Type	Required	Description
location	path	string	No

**CacheClearRs** Parameters:
Name	Parameter	Data Type	Required
Result	form	CacheClearResult	No
BeforeStatistics	form	CacheStatResult	No
AfterStatistics	form	CacheStatResult	No

**CacheClearResult** Parameters:
Name	Parameter	Data Type	Required	Description
IsCleared	form	bool	No

**CacheResultBase** Parameters:
Name	Parameter	Data Type	Required
Result	form	CacheResult	No
Location	form	CacheLocation	No
Key	form	CacheKey	No

**CacheResult** Enum:
Name	Value
None	0
Miss	1
Hit	2
Put	4
Deleted	8
Cleared	16
Added	32
Updated	64
Unavailable	128
Expired	256

**CacheLocation** Enum:
Name	Value
None	0
OutOfProcess	1
InProcess	2
InContext	3

**CacheKey** Parameters:
Name	Parameter	Data Type	Required
Region	form	string	No
BaseKey	form	string	No
Key	form	string	No
ExpirationSeconds	form	int	No

**CacheStatResult** Parameters:
Name	Parameter	Data Type	Required	Description
Statistics	form	List<CacheStat>	No
IsHit	form	bool	No

**CacheStat** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

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>