FlushApplicationCache API¶

Flushes the in-memory application cache, forcing the system to reload configuration and cached data from the database and file system. Only administrators can call it: the sysadmin account and members of [Administrators].

Endpoint¶

/srv.asmx/FlushApplicationCache

Methods¶

GET /srv.asmx/FlushApplicationCache?authenticationTicket=...
POST /srv.asmx/FlushApplicationCache (form data)
SOAP Action: http://tempuri.org/FlushApplicationCache

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`

Response Structure¶

Success Response¶

<response success="true" />

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

Administrators only: the sysadmin account and members of [Administrators]. No other role, User Managers included, may flush the cache.
Anyone else is refused with errorCode="4030".

Use Cases¶

Configuration Changes
Force reload after direct database changes to application settings
Refresh cached data after bulk operations
Troubleshooting
Clear stale cached data that may cause unexpected behavior
Reset application state without restarting the service
Maintenance
Refresh after license file updates
Clear cache after system migrations or upgrades

Example Requests¶

Request (GET)¶

GET /srv.asmx/FlushApplicationCache?authenticationTicket=abc123-def456 HTTP/1.1
Host: server.example.com

Request (POST)¶

POST /srv.asmx/FlushApplicationCache HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123-def456

Request (SOAP 1.1)¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/FlushApplicationCache"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FlushApplicationCache xmlns="http://tempuri.org/">
      <authenticationTicket>abc123-def456</authenticationTicket>
    </FlushApplicationCache>
  </soap:Body>
</soap:Envelope>

Integration Examples¶

JavaScript/Client-Side¶

async function flushApplicationCache() {
    const ticket = getUserAuthTicket();

    const response = await fetch("/srv.asmx/FlushApplicationCache", {
        method: "POST",
        headers: { "Content-Type": "application/x-www-form-urlencoded" },
        body: `authenticationTicket=${encodeURIComponent(ticket)}`
    });

    const xmlText = await response.text();
    const parser = new DOMParser();
    const xmlDoc = parser.parseFromString(xmlText, "text/xml");

    const root = xmlDoc.querySelector("response");
    if (root.getAttribute("success") === "true") {
        console.log("Application cache flushed successfully.");
    } else {
        const error = root.getAttribute("error");
        throw new Error(error);
    }
}

C# Client Usage¶

using (var client = new SrvSoapClient())
{
    try
    {
        var response = await client.FlushApplicationCacheAsync(authTicket);
        var root = XElement.Parse(response.ToString());

        if (root.Attribute("success")?.Value == "true")
        {
            Console.WriteLine("Application cache flushed successfully.");
        }
        else
        {
            var error = root.Attribute("error")?.Value;
            Console.WriteLine($"Error: {error}");
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine($"Exception: {ex.Message}");
    }
}

Notes¶

This operation calls Settings.FlushCache() which clears the in-memory application settings cache.
The cache will be repopulated on the next request that accesses cached settings.
This operation does not affect user sessions or authentication tickets.
Use sparingly in production environments as cache rebuilding may temporarily impact performance.
This does not restart the application or recycle the application pool.

Error Codes¶

The errorCode values this operation returns, checked against a running server:

`errorCode`	When
`4010`	the ticket is expired or unknown
`4030`	a caller with no ticket, or a signed-in caller who is not an administrator

Common error responses:

Error	Description
`[901]Session expired or Invalid ticket`	Invalid or expired authentication ticket
`[921]Insufficient rights`	The caller is not an administrator

GetMaintenanceJobsStatus - Get maintenance jobs status
GetWarehouseStatus - Get warehouse storage status
ServerInfo - Get basic server information
AuthenticateUser - Authenticate and obtain a ticket

Version History¶

New in current version: Provides programmatic cache management for system administrators
Admin-only for security and stability reasons