Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:ApiAccessRuleType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 16 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 16 elements, elem. wildcard
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:CallName?, ns:CountsTowardAggregate?, ns:DailyHardLimit?, ns:DailySoftLimit?, ns:DailyUsage?, ns:HourlyHardLimit?, ns:HourlySoftLimit?, ns:HourlyUsage?, ns:Period?, ns:PeriodicHardLimit?, ns:PeriodicSoftLimit?, ns:PeriodicUsage?, ns:PeriodicStartDate?, ns:ModTime?, ns:RuleCurrentStatus?, ns:RuleStatus?, {any}*
</...>
All Direct / Indirect Based Elements (1):
ns:ApiAccessRule
Known Usage Locations
Annotation
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.
XML Source (w/o annotations (17); see within schema source)
<xs:complexType name="ApiAccessRuleType">
<xs:sequence>
<xs:element minOccurs="0" name="CallName" type="xs:string"/>
<xs:element minOccurs="0" name="CountsTowardAggregate" type="xs:boolean"/>
<xs:element minOccurs="0" name="DailyHardLimit" type="xs:long"/>
<xs:element minOccurs="0" name="DailySoftLimit" type="xs:long"/>
<xs:element minOccurs="0" name="DailyUsage" type="xs:long"/>
<xs:element minOccurs="0" name="HourlyHardLimit" type="xs:long"/>
<xs:element minOccurs="0" name="HourlySoftLimit" type="xs:long"/>
<xs:element minOccurs="0" name="HourlyUsage" type="xs:long"/>
<xs:element minOccurs="0" name="Period" type="xs:int"/>
<xs:element minOccurs="0" name="PeriodicHardLimit" type="xs:long"/>
<xs:element minOccurs="0" name="PeriodicSoftLimit" type="xs:long"/>
<xs:element minOccurs="0" name="PeriodicUsage" type="xs:long"/>
<xs:element minOccurs="0" name="PeriodicStartDate" type="xs:dateTime"/>
<xs:element minOccurs="0" name="ModTime" type="xs:dateTime"/>
<xs:element minOccurs="0" name="RuleCurrentStatus" type="ns:AccessRuleCurrentStatusCodeType"/>
<xs:element minOccurs="0" name="RuleStatus" type="ns:AccessRuleStatusCodeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 17/17)
ns:CallName
Type:
xs:string, predefined, simple content
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.
XML Representation Summary
<ns:CallName>
   
Content: 
{ xs:string }
</ns:CallName>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CallName" type="xs:string"/>
ns:CountsTowardAggregate
Type:
xs:boolean, predefined, simple content
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.
XML Representation Summary
<ns:CountsTowardAggregate>
   
Content: 
{ xs:boolean }
</ns:CountsTowardAggregate>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="CountsTowardAggregate" type="xs:boolean"/>
ns:DailyHardLimit
Type:
xs:long, predefined, simple content
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).
XML Representation Summary
<ns:DailyHardLimit>
   
Content: 
{ xs:long }
</ns:DailyHardLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DailyHardLimit" type="xs:long"/>
ns:DailySoftLimit
Type:
xs:long, predefined, simple content
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.
XML Representation Summary
<ns:DailySoftLimit>
   
Content: 
{ xs:long }
</ns:DailySoftLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DailySoftLimit" type="xs:long"/>
ns:DailyUsage
Type:
xs:long, predefined, simple content
This value indicates the number of times that the application has used this call today. The day starts at midnight, 00:00:00 PST.
XML Representation Summary
<ns:DailyUsage>
   
Content: 
{ xs:long }
</ns:DailyUsage>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="DailyUsage" type="xs:long"/>
ns:HourlyHardLimit
Type:
xs:long, predefined, simple content
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).
XML Representation Summary
<ns:HourlyHardLimit>
   
Content: 
{ xs:long }
</ns:HourlyHardLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="HourlyHardLimit" type="xs:long"/>
ns:HourlySoftLimit
Type:
xs:long, predefined, simple content
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).
XML Representation Summary
<ns:HourlySoftLimit>
   
Content: 
{ xs:long }
</ns:HourlySoftLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="HourlySoftLimit" type="xs:long"/>
ns:HourlyUsage
Type:
xs:long, predefined, simple content
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).
XML Representation Summary
<ns:HourlyUsage>
   
Content: 
{ xs:long }
</ns:HourlyUsage>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="HourlyUsage" type="xs:long"/>
ns:ModTime
Type:
xs:dateTime, predefined, simple content
This timestamp marks the date and time when the access rule was last modified by eBay.
XML Representation Summary
<ns:ModTime>
   
Content: 
{ xs:dateTime }
</ns:ModTime>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ModTime" type="xs:dateTime"/>
ns:Period
Type:
xs:int, predefined, simple content
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.
XML Representation Summary
<ns:Period>
   
Content: 
{ xs:int }
</ns:Period>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Period" type="xs:int"/>
ns:PeriodicHardLimit
Type:
xs:long, predefined, simple content
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.
XML Representation Summary
<ns:PeriodicHardLimit>
   
Content: 
{ xs:long }
</ns:PeriodicHardLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PeriodicHardLimit" type="xs:long"/>
ns:PeriodicSoftLimit
Type:
xs:long, predefined, simple content
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.
XML Representation Summary
<ns:PeriodicSoftLimit>
   
Content: 
{ xs:long }
</ns:PeriodicSoftLimit>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PeriodicSoftLimit" type="xs:long"/>
ns:PeriodicStartDate
Type:
xs:dateTime, predefined, simple content
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.
XML Representation Summary
<ns:PeriodicStartDate>
   
Content: 
{ xs:dateTime }
</ns:PeriodicStartDate>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PeriodicStartDate" type="xs:dateTime"/>
ns:PeriodicUsage
Type:
xs:long, predefined, simple content
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.
XML Representation Summary
<ns:PeriodicUsage>
   
Content: 
{ xs:long }
</ns:PeriodicUsage>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="PeriodicUsage" type="xs:long"/>
ns:RuleCurrentStatus
Type:
ns:AccessRuleCurrentStatusCodeType, simple content
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.
XML Representation Summary
<ns:RuleCurrentStatus>
   
Content: 
{ enumeration of xs:token }
</ns:RuleCurrentStatus>
Simple Content
Enumeration:
"NotSet"
 - 
This value indicates that usage limits do not apply to the corresponding API call.
"HourlyLimitExceeded"
 - 
This value indicates that your application has exceeded its hourly hard call limit for the corresponding API call.
"DailyLimitExceeded"
 - 
This value indicates that your application has exceeded its daily hard call limit for 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.
"HourlySoftLimitExceeded"
 - 
This value indicates that your application has exceeded its hourly soft 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.
"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.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="RuleCurrentStatus" type="ns:AccessRuleCurrentStatusCodeType"/>
ns:RuleStatus
Type:
ns:AccessRuleStatusCodeType, simple content
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.
XML Representation Summary
<ns:RuleStatus>
   
Content: 
{ enumeration of xs:token }
</ns:RuleStatus>
Simple Content
Enumeration:
"RuleOff"
 - 
This value indicates that the rule is turned off, and no rule validation was performed.
"RuleOn"
 - 
This value indicates that the rule is turned on, and rule validation was performed.
"ApplicationBlocked"
 - 
This value indicates that the application is blocked from making requests to the call named in this rule.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="RuleStatus" type="ns:AccessRuleStatusCodeType"/>
{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.