eBay Trading APIVersion 1299
 

GetApiAccessRules

Note: This call is deprecated and is scheduled for decommission on March 10, 2023. Starting on August 22, 2022, this call will only return the ApplicationAggregate container, and no usage data on specific Trading calls. Going forward, we recommend that you make plans to migrate to the Developer Analytics API, an API that retrieves all usage data on all RESTful APIs and the Trading API.

Use this call to report on how many Trading API calls your application has made and how many it is allowed to make. The call retrieves the access rules for various Trading API calls and shows how many calls your application has made in the past hour and past day.


Important: This API call only returns data on Trading API calls.

Call rates are set by eBay and can be limited on an application basis or a per-user basis, depending on your customer base and distribution format. Call rate limits are set at the sole discretion of eBay. Applications are rate-limited on a per application basis or per user, depending on your customer base and distribution format.

Note: Application-based call limits represent a maximum API call cap on a daily and monthly basis.

Some calls have an hourly or daily usage rule, and each rule has a soft limit (resulting in a warning) and a hard limit (resulting in blocking). GetApiAccessRules tells you what the limits are and whether your application is within them.

The rules define how many times an application can use certain Trading API calls each day or hour. A day starts at 00:00:00 PST (midnight) and ends at 11:59:59 PST. An hour is measured from the beginning of the hour, 12:00, 1:00, and so on. Your application also has an aggregate call limit, although not all calls are counted toward the limit.

GetApiAccessRules has no call-specific input fields. You only pass in the fields that are standard for all Trading API calls (e.g., RequesterCredentials). If the call is successful, it returns a number of ApiAccessRule containers, where each one has the details of the respective access rule. Each access rule contains a CallName. Parse the response for each call name, paying special attention to the values for DailyUsage, HourlyUsage, and PeriodicUsage.

For a summary of your application calls, search the response for a CallName field whose value is ApplicationAggregate, and review the values for DailyUsage, HourlyUsage, and PeriodicUsage to see how many API calls you have made.

The easiest way to track your application's API usage statistics is to use the Application reports page, available from the My Account page on the eBay Developers Program web site. The next best way is to use GetApiAccessRules. Use this call for diagnostic purposes only, for example, when your application has blocked calls. Your application does not need to call it regularly to check daily and hourly usage.

Below are some sample access rule values for ApplicationAggregate (a call summary):

<ApiAccessRule>
	<CallName>ApplicationAggregate</CallName>
	<CountsTowardAggregate>true</CountsTowardAggregate>
	<DailyHardLimit>100000000</DailyHardLimit>
	<DailySoftLimit>90000000</DailySoftLimit>
	<DailyUsage>37897</DailyUsage>
	<HourlyHardLimit>100000000</HourlyHardLimit>
	<HourlySoftLimit>90000000</HourlySoftLimit>
	<HourlyUsage>2056</HourlyUsage>
	<Period>-1</Period>
	<PeriodicHardLimit>0</PeriodicHardLimit>
	<PeriodicSoftLimit>0</PeriodicSoftLimit>
	<PeriodicUsage>0</PeriodicUsage>
	<ModTime>2008-03-27T20:49:51.000Z</ModTime>
	<RuleCurrentStatus>NotSet</RuleCurrentStatus>
	<RuleStatus>RuleOn</RuleStatus>
</ApiAccessRule>

Use GetApiAccessRules in the Sandbox to become familiar with the various access limits for your application. Call it periodically in Production to keep an eye on the limits you may be approaching. How often you call it depends on your developer tier and on the tasks your application performs. Any blocked calls become usable during the next day or hour, depending on the type of call.

To test the call in the Sandbox, add one or more calls to GetApiAccessRules in various spots in your application to test its API usage. Remove the calls before moving into the Production environment.

See Compatible Application Check.



Input Output Detail Controls Samples Change History

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls). 

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Input fields) -->

  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetApiAccessRulesRequest>
Argument Type Occurrence Meaning
(No call-specific fields)
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States
MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP Headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Input Output Detail Controls Samples Change History

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ApiAccessRule> ApiAccessRuleType
    <CallName> string </CallName>
    <CountsTowardAggregate> boolean </CountsTowardAggregate>
    <DailyHardLimit> long </DailyHardLimit>
    <DailySoftLimit> long </DailySoftLimit>
    <DailyUsage> long </DailyUsage>
    <HourlyHardLimit> long </HourlyHardLimit>
    <HourlySoftLimit> long </HourlySoftLimit>
    <HourlyUsage> long </HourlyUsage>
    <ModTime> dateTime </ModTime>
    <Period> int </Period>
    <PeriodicHardLimit> long </PeriodicHardLimit>
    <PeriodicSoftLimit> long </PeriodicSoftLimit>
    <PeriodicStartDate> dateTime </PeriodicStartDate>
    <PeriodicUsage> long </PeriodicUsage>
    <RuleCurrentStatus> AccessRuleCurrentStatusCodeType </RuleCurrentStatus>
    <RuleStatus> AccessRuleStatusCodeType </RuleStatus>
  </ApiAccessRule>
  <!-- ... more ApiAccessRule nodes allowed here ... -->
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetApiAccessRulesResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
ApiAccessRule ApiAccessRuleType Always,
repeatable: [1..*]		 Each returned ApiAccessRule container includes the application's current daily, hourly, and periodic usage of a call, and the maximum amount of times that the application can make that call during the given period.
ApiAccessRule.CallName string Always 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.
ApiAccessRule
  .CountsTowardAggregate 		boolean Always This boolean field will indicate whether or not the use of the call (indicated in CallName field) counts toward the application's aggregate limit for all calls.
ApiAccessRule.DailyHardLimit long Always This value indicates the total number of calls per day that the application can make to this call before being blocked. The day starts at midnight, 00:00:00 PST (not GMT).
ApiAccessRule.DailySoftLimit long Always This value indicates the total number of calls per day that the application can make to this call before you receive a warning. The day starts at midnight, 00:00:00 PST.
ApiAccessRule.DailyUsage long Always This value indicates the number of times that the application has used this call today. The day starts at midnight, 00:00:00 PST.
ApiAccessRule.HourlyHardLimit long Always This value indicates the total number of calls per hour that the application can make to this call before being blocked. Each count begins at the top of each hour (e.g. 1:00:00).
ApiAccessRule.HourlySoftLimit long Always This value indicates the total number of calls per hour that the application can make to this call before you receive a warning. Each count begins at the top of each hour (e.g. 1:00:00).
ApiAccessRule.HourlyUsage long Always This value indicates the number of times that the application has used this call during this hour. Each count begins at the top of each hour (e.g. 1:00:00).
ApiAccessRule.ModTime dateTime Always This timestamp marks the date and time when the access rule was last modified by eBay.
ApiAccessRule.Period int Always 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.
ApiAccessRule
  .PeriodicHardLimit 		long Always 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.
ApiAccessRule
  .PeriodicSoftLimit 		long Always 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.
ApiAccessRule
  .PeriodicStartDate 		dateTime Conditionally 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.
ApiAccessRule.PeriodicUsage long Always 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.
ApiAccessRule
  .RuleCurrentStatus 		AccessRuleCurrentStatusCodeType Conditionally This enumeration value will only be returned if a hourly, daily, or periodic hard or soft call limit is exceeded by the application, or if call limits do not apply to the call.

Applicable values: See RuleCurrentStatus.
Code so that your app gracefully handles any future changes to this list.
ApiAccessRule.RuleStatus AccessRuleStatusCodeType Always This enumeration value will indicate whether the access rule is on or off, or if the application is currently being blocked due to exceeding a hard call limit.

Applicable values:

ApplicationBlocked
(out) This value indicates that the application is blocked from making requests to the call named in this rule.
CustomCode
(out) Reserved for internal or future use.
RuleOff
(out) This value indicates that the rule is turned off, and no rule validation was performed.
RuleOn
(out) This value indicates that the rule is turned on, and rule validation was performed.

Code so that your app gracefully handles any future changes to this list.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Input Output Detail Controls Samples Change History

Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Input Output Detail Controls Samples Change History

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Retrieves the current set of API access rules and call usage for the authenticated user.

Description

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetApiAccessRulesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
</GetApiAccessRulesRequest>

Output

XML format.
<GetApiAccessRulesResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-04T17:59:04.407Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
  <ApiAccessRule>
    <CallName>ApplicationAggregate</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>27</DailyUsage>
    <HourlyHardLimit>6000</HourlyHardLimit>
    <HourlySoftLimit>6000</HourlySoftLimit>
    <HourlyUsage>20</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>10000</PeriodicHardLimit>
    <PeriodicSoftLimit>10000</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <PeriodicStartDate>2006-02-14T07:00:00.000Z</PeriodicStartDate>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>AddItem</CallName>
    <CountsTowardAggregate>false</CountsTowardAggregate>
    <DailyHardLimit>100000</DailyHardLimit>
    <DailySoftLimit>100000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>100000</HourlyHardLimit>
    <HourlySoftLimit>100000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>LeaveFeedback</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>5000</HourlyHardLimit>
    <HourlySoftLimit>5000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOff</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>RelistItem</CallName>
    <CountsTowardAggregate>false</CountsTowardAggregate>
    <DailyHardLimit>50000</DailyHardLimit>
    <DailySoftLimit>50000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>50000</HourlyHardLimit>
    <HourlySoftLimit>50000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>GetAPIAccessRules</CallName>
    <CountsTowardAggregate>false</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>5000</HourlyHardLimit>
    <HourlySoftLimit>5000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOff</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>SetApplication</CallName>
    <CountsTowardAggregate>false</CountsTowardAggregate>
    <DailyHardLimit>50</DailyHardLimit>
    <DailySoftLimit>50</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>50</HourlyHardLimit>
    <HourlySoftLimit>50</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOff</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>GetNotificationPreferences</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>5000</HourlyHardLimit>
    <HourlySoftLimit>5000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>SetNotificationPreferences</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>5000</HourlyHardLimit>
    <HourlySoftLimit>5000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>PasswordAuthenticationLimiter</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>NonUTF8UsageLimiter</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>GetNotificationsUsage</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>1000</DailyHardLimit>
    <DailySoftLimit>1000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>50</HourlyHardLimit>
    <HourlySoftLimit>50</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>LegacyXmlEnforcementSoft</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>0</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <PeriodicStartDate>2008-10-03T07:00:00.000Z</PeriodicStartDate>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>LegacyXmlEnforcementHard</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>0</DailyHardLimit>
    <DailySoftLimit>0</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>0</HourlyHardLimit>
    <HourlySoftLimit>0</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>0</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <PeriodicStartDate>2008-10-03T07:00:00.000Z</PeriodicStartDate>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>ApplicationBlocked</RuleStatus>
  </ApiAccessRule>
  <ApiAccessRule>
    <CallName>GetSearchResultsExpress</CallName>
    <CountsTowardAggregate>true</CountsTowardAggregate>
    <DailyHardLimit>5000</DailyHardLimit>
    <DailySoftLimit>5000</DailySoftLimit>
    <DailyUsage>0</DailyUsage>
    <HourlyHardLimit>5000</HourlyHardLimit>
    <HourlySoftLimit>5000</HourlySoftLimit>
    <HourlyUsage>0</HourlyUsage>
    <Period>-1</Period>
    <PeriodicHardLimit>0</PeriodicHardLimit>
    <PeriodicSoftLimit>0</PeriodicSoftLimit>
    <PeriodicUsage>0</PeriodicUsage>
    <ModTime>2008-10-02T15:23:15.000Z</ModTime>
    <RuleCurrentStatus>NotSet</RuleCurrentStatus>
    <RuleStatus>RuleOn</RuleStatus>
  </ApiAccessRule>
</GetApiAccessRulesResponse>



Input Output Detail Controls Samples Change History

Change History

Change Date Description
427
2005-09-21
  • RuleCurrentStatus (modified): Now indicates whether hourly, daily, and periodic hard and soft limits were exceeded.