This type is used by the ApiAccessRule container that is returned in the GetApiAccessRules call response. An ApiAccessRule container will be returned for every Trading API call that the user/application has used. The ApiAccessRule container consists of hourly, daily, and periodic call limits for the call, the total number of times the call was used, and other information about usage of the call.
The value in this field can be the name of a Trading API call, or it can be ApplicationAggregate (returns totals for all calls), PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter. All of the other data in the ApiAccessRule container will pertain to this call, including the call limits.
The length of time before your application's periodic usage counter restarts for this call. If the number of calls you make exceeds the periodic hard limit before the current period ends, further calls will be blocked until the next period starts. Possible values: -1 (Periodic limit not enforced, could be any negative integer), 0 (Calendar month), 30 (Number of days, could be any positive integer). If the period is based on the calendar month, the usage counters restart on the same day of every month, regardless of the number of days in the month.
This value indicates the number of calls per period that your application may make before a call is blocked, if the periodic limit is enforced. The length of the period is specified in the Period field.
See the Field Index to learn which calls use PeriodicHardLimit.
This value indicates the number of calls per period that your application may make before receiving a warning, if the periodic limit is enforced. The length of the period is specified in the Period field.
See the Field Index to learn which calls use PeriodicSoftLimit.
This timestamp (in GMT) marks the date and time when the access rule's period started. The period starts at midnight Pacific time. For example, if the period begins on June 29 in 2005 when California is on Pacific Daylight Time, the GMT value returned would be 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when California is on Pacific Standard Time, the GMT value returned would be 2005-12-29T08:00:00.000Z. This field is only returned when the eBay Developers Program has configured the start date for the access rule. The start date can vary per application and per call name.
See the Field Index to learn which calls use PeriodicStartDate.
This value indicates the number of times that the application has used this call during this period. 0 is returned if the periodic access rule has not been configured for the application. The length of the period is specified in Period field and the start date of the period is specified in PeriodicStartDate field.
See the Field Index to learn which calls use PeriodicUsage.