AccessRuleCurrentStatusCodeType ( token )
Enumerated type that defines the possible values that can be returned in the RuleCurrentStatus output field of the GetApiAccessRules call. The RuleCurrentStatus is only returned if the daily, hourly, or periodic call limit for the corresponding API call has been exceeded, or if a call limit does not apply to the API call.
Type that uses AccessRuleCurrentStatusCodeType:
Call that uses one or more values of AccessRuleCurrentStatusCodeType:
Enumeration Values
Value | Description |
CustomCode | Reserved for internal or future use. |
DailyLimitExceeded | This value indicates that your application has exceeded its daily hard call limit for the corresponding API call. |
DailySoftLimitExceeded | This value indicates that your application has exceeded its daily soft call limit for the corresponding API call. |
HourlyLimitExceeded | This value indicates that your application has exceeded its hourly hard call limit for the corresponding API call. |
HourlySoftLimitExceeded | This value indicates that your application has exceeded its hourly soft call limit for the corresponding API call. |
NotSet | This value indicates that usage limits do not apply to the corresponding API call. |
PeriodicLimitExceeded | This value indicates that your application has exceeded its periodic hard call limit for the corresponding API call. The period is defined in the ApiAccessRule.Period field and can be a calendar month or a specific number of days. |
PeriodicSoftLimitExceeded | This value indicates that your application has exceeded its periodic soft call limit for the corresponding API call. The period is defined in the ApiAccessRule.Period field and can be a calendar month or a specific number of days. |