eBay::API::XML::DataType::ApiAccessRuleType(3)

NAME
eBay::API::XML::DataType::ApiAccessRuleType

DESCRIPTION
Contains the definition of a rule that governs the number of times your application can access the eBay API (invoke a call) on an hourly, daily, or periodic basis.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::ApiAccessRuleType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setCallName()
The name of the call that has an access rule. Can be a call name (e.g., AddItem), ApplicationAggregate (returns totals for all calls), PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter.

# Argument: 'xs:string'

  getCallName()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:string'

  setCountsTowardAggregate()
Whether use of this call counts toward the application's aggregate limit for all calls.

# Argument: 'xs:boolean'

  isCountsTowardAggregate()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:boolean'

  setDailyHardLimit()
The number of calls per day that your application can make to this call before being refused. The day starts at midnight, 00:00:00 PST (not GMT).

# Argument: 'xs:long'

  getDailyHardLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setDailySoftLimit()
The number of calls per day that your application can make to this call before you receive a warning. The day starts at midnight, 00:00:00 PST.

# Argument: 'xs:long'

  getDailySoftLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setDailyUsage()
The number of times your application has used this call today.

# Argument: 'xs:long'

  getDailyUsage()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setHourlyHardLimit()
The number of calls that your application can make per hour to this call before being refused. Each count begins on the hour (e.g. 1:00:00).

# Argument: 'xs:long'

  getHourlyHardLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setHourlySoftLimit()
The number of calls that your application can make to this call per hour before you receive a warning. Each count begins on the hour (e.g. 1:00:00).

# Argument: 'xs:long'

  getHourlySoftLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setHourlyUsage()
The number of times your application has executed this call during this hour.

# Argument: 'xs:long'

  getHourlyUsage()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setModTime()
The date and time this access rule was last modified by eBay.

# Argument: 'xs:dateTime'

  getModTime()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:dateTime'

  setPeriod()
The length of time before your application's perodic 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 refused 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.

# Argument: 'xs:int'

  getPeriod()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:int'

  setPeriodicHardLimit()
Number of calls per period that your application may make before a call is refused, if the periodic limit is enforced. The length of the period is specified in Period.

# Argument: 'xs:long'

  getPeriodicHardLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setPeriodicSoftLimit()
Number of calls per period that your application may make before you receive a warning, if the periodic limit is enforced. The length of the period is specified in Period.

# Argument: 'xs:long'

  getPeriodicSoftLimit()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setPeriodicStartDate()
The time (in GMT) when this 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. 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 (i.e., per access rule).

# Argument: 'xs:dateTime'

  getPeriodicStartDate()
  Calls: GetApiAccessRules
  Returned: Conditionally

# Returns: 'xs:dateTime'

  setPeriodicUsage()
Number of calls that your application has already made this period. Returns 0 if the periodic access rule has not been configured for the application. The length of the period is specified in Period. The start date of the period is specified in PeriodicStartDate.

# Argument: 'xs:long'

  getPeriodicUsage()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'xs:long'

  setRuleCurrentStatus()
Your application's current status for this rule, including whether the rule is set for your application and whether the application has exceeded its daily or hourly limit.

# Argument: 'ns:AccessRuleCurrentStatusCodeType'

  getRuleCurrentStatus()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'ns:AccessRuleCurrentStatusCodeType'

  setRuleStatus()
The status of the access rule, including whether the rule is turned on or off and whether the application is currently blocked from using this call. No effect if RuleCurrentStatus is set to NotSet.

# Argument: 'ns:AccessRuleStatusCodeType'

  getRuleStatus()
  Calls: GetApiAccessRules
  Returned: Always

# Returns: 'ns:AccessRuleStatusCodeType'