/
PwsRateLimitSnapshot

PwsRateLimitSnapshot

Overview

 

This structure contains a snapshot of the rate limits resulting from executing the web service PwsTestRateLimiter

Format

 

  • PwsRateLimitSnapshot

    • EnabledFlag: Boolean

    • InstallationHitCount: Int32

    • InstallationRateLimit: Int32

    • RollingWindowSeconds: Int32

    • SessionHitCount: Int32

    • SessionRateLimit: Int32

    • UserHitCount: Int32

    • UserRateLimit: Int32

 

Elements

 

Element

Data Type

Description

Sample Data

Element

Data Type

Description

Sample Data

EnabledFlag

Boolean

True if rate limiting is enabled, false if not.

true

InstallationHitCount

Int32

The number of hits against the installation

1601

InstallationRateLimit

Int32

The installation rate limit

2400

RollingWindowSeconds

Int32

The number of seconds in the rolling window in which hits are counted.

60

SessionHitCount

Int32

The number of session hits against the installation

1201

SessionRateLimit

Int32

The installation session limit

1200

UserHitCount

Int32

The number of user hits against the installation

2001

UserRateLimit

Int32

The installation user hit limit

1800

Usage Example(s)

 

<a:RateLimitSnapshot xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:EnabledFlag>false</b:EnabledFlag> <b:InstallationHitCount>1601</b:InstallationHitCount> <b:InstallationRateLimit>2400</b:InstallationRateLimit> <b:RollingWindowSeconds>60</b:RollingWindowSeconds> <b:SessionHitCount>1201</b:SessionHitCount> <b:SessionRateLimit>1200</b:SessionRateLimit> <b:UserHitCount>2001</b:UserHitCount> <b:UserRateLimit>1800</b:UserRateLimit> </a:RateLimitSnapshot>