Overview
This web service allows users to test rate limits for the following web services:is provided so that developers may test that their code properly handles Rate Limit errors from Projector.
In its simplest invocation, this service will simply respond with current “at this moment in time” counts in use by the rate limiter for the current user, current session, and current installation (account), as well as the thresholds that are in use by the limiter.
The service may also be used to simulate additional “hits” to land at the server either before or after counts are applied to the limiting algorithm is brought to bear.
| Note |
|---|
WARNING: If you use this service to simulate hits, those hits will remain part of the algorithm for this and all other services that are invoked before the rolling window expires. |
Request Format
PwsTestRateLimiter
serviceRequest: PwsTestRateLimiterRq
RequestId: Int32
SessionTicket: String
SimulateInstallationHitsAfter: Int32
SimulateInstallationHitsBefore: Int32
SimulateSessionHitsAfter: Int32
SimulateSessionHitsBefore: Int32
SimulateUserHitsAfter: Int32
SimulateUserHitsBefore: Int32
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. |
| ||
String | Yes | Click here for more information. |
| ||
SimulateInstallationHitsAfter | Int32 | No | Simulate this many installation hits AFTER application of limiting algorithm. |
| |
SimulateInstallationHitsBefore | Int32 | No | Simulate this many installation hits BEFORE application of limiting algorithm. |
| |
SimulateSessionHitsAfter | Int32 | No | Simulate this many session hits AFTER application of limiting algorithm. |
| |
SimulateSessionHitsBefore | Int32 | No | Simulate this many session hits BEFORE application of limiting algorithm. |
| |
SimulateUserHitsAfter | Int32 | No | Simulate this many user hits AFTER application of limiting algorithm. |
| |
SimulateUserHitsBefore | Int32 | No | Simulate this many user hits BEFORE application of limiting algorithm. |
|
Request Usage Example(s)
...