s1 API Host

<back to all web services

GetCacheKeysRequest

The following routes are available for this service:
GET, OPTIONS/api/admin/cache-managementGet the first x number of keys that contain the given searchkeyUser has to be authenticated and admin to retrieve the information.
Parameters:
NameParameterData TypeRequiredDescription
patternquerystringYesThe string to use when searching for cache keys.

To override the Content-type in your clients 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.

POST /xml/reply/GetCacheKeysRequest HTTP/1.1 
Host: s1-api.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetCacheKeysRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.Cache">
  <Pattern>String</Pattern>
</GetCacheKeysRequest>

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

<GetCacheKeysResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.Cache">
  <CacheKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</GetCacheKeysResponse>