Billhighway Cloud API

<back to all web services

CacheClearRq

The following routes are available for this service:
DELETE/devops/api/caches/{location}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.DTO.Caching.Api.Request
Imports BH.CloudAPI.DTO.Caching.Api.Response
Imports BH.Caching

Namespace Global

    Namespace BH.Caching

        Public Partial Class CacheClearResult
            Inherits CacheResultBase
            Public Overridable Property IsCleared As Boolean
        End Class

        Public Partial Class CacheKey
            Public Overridable Property Region As String
            Public Overridable Property BaseKey As String
            Public Overridable Property Key As String
            Public Overridable Property ExpirationSeconds As Integer
        End Class

        Public Enum CacheLocation
            None = 0
            OutOfProcess = 1
            InProcess = 2
            InContext = 3
        End Enum

        <Flags>
        Public Enum CacheResult
            None = 0
            Miss = 1
            Hit = 2
            Put = 4
            Deleted = 8
            Cleared = 16
            Added = 32
            Updated = 64
            Unavailable = 128
            Expired = 256
        End Enum

        Public Partial Class CacheResultBase
            Public Overridable Property Result As CacheResult
            Public Overridable Property Location As CacheLocation
            Public Overridable Property Key As CacheKey
        End Class

        Public Partial Class CacheStat
            Public Overridable Property Name As String
            Public Overridable Property Value As String
        End Class

        Public Partial Class CacheStatResult
            Inherits CacheResultBase
            Public Sub New()
                Statistics = New List(Of CacheStat)
            End Sub

            Public Overridable Property Statistics As List(Of CacheStat)
            Public Overridable Property IsHit As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.Caching.Api.Request

        Public Partial Class CacheClearRq
            Public Overridable Property location As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.DTO.Caching.Api.Response

        Public Partial Class CacheClearRs
            Public Overridable Property Result As CacheClearResult
            Public Overridable Property BeforeStatistics As CacheStatResult
            Public Overridable Property AfterStatistics As CacheStatResult
        End Class
    End Namespace
End Namespace

VB.NET CacheClearRq 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} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Result":{"IsCleared":false,"Result":0,"Location":0},"BeforeStatistics":{"Statistics":[{"Name":"String","Value":"String"}],"IsHit":false,"Result":0,"Location":0},"AfterStatistics":{"Statistics":[{"Name":"String","Value":"String"}],"IsHit":false,"Result":0,"Location":0}}