Get all recurring jobs submitted by this seller. There should only be one recurring job per job type.
Output Samples Change History |
getRecurringJobs has no input fields.
Input Samples Change History |
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 Samples.
<?xml version="1.0" encoding="utf-8"?> <getRecurringJobsResponse xmlns="http://www.ebay.com/marketplace/services"> <!-- Call-specific Output Fields --> <recurringJobDetail> RecurringJobDetail <creationTime> dateTime </creationTime> <dailyRecurrence> DailyRecurrence <timeOfDay> time </timeOfDay> </dailyRecurrence> <downloadJobType> token </downloadJobType> <frequencyInMinutes> int </frequencyInMinutes> <jobStatus> RecurringJobStatus </jobStatus> <monthlyRecurrence> MonthlyRecurrence <dayOfMonth> token </dayOfMonth> <timeOfDay> time </timeOfDay> </monthlyRecurrence> <recurringJobId> string </recurringJobId> <weeklyRecurrence> WeeklyRecurrence <dayOfWeek> token </dayOfWeek> <timeOfDay> time </timeOfDay> </weeklyRecurrence> </recurringJobDetail> <!-- ... more recurringJobDetail nodes allowed here ... --> <!-- Standard Output Fields --> <ack> AckValue </ack> <errorMessage> ErrorMessage <error> ErrorData <category> ErrorCategory </category> <domain> string </domain> <errorId> long </errorId> <exceptionId> token </exceptionId> <message> string </message> <parameter name="string"> ErrorParameter (string) </parameter> <!-- ... more parameter nodes allowed here ... --> <severity> ErrorSeverity </severity> <subdomain> string </subdomain> </error> <!-- ... more error nodes allowed here ... --> </errorMessage> <timestamp> dateTime </timestamp> <version> string </version> </getRecurringJobsResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
recurringJobDetail | RecurringJobDetail | Always,
repeatable: [1..*] |
One or more recurringJobDetail containers are returned for each retrieved recurring job. The recurringJobDetail container consists of a unique identifier for the recurring job, the current status of the recurring job ('Active' or 'Suspended), the frequency of the recurring job (daily, weekly, monthly), and the download job type. |
recurringJobDetail .creationTime |
dateTime | Always | This timestamp indicates the date and time that the Bulk Data Exchange job was created. |
recurringJobDetail .dailyRecurrence |
DailyRecurrence | Conditionally | This container is only returned if a daily recurrence was set up for the recurring job. If a recurring job is set up to run on a daily basis, the time of day is returned under the dailyRecurrence container. |
recurringJobDetail .dailyRecurrence.timeOfDay |
time | Conditionally |
This value is used to specify the time of day that the job will execute on a daily basis. The 24-hour clock and GMT are used. 'HH:MM:SS' is the convention that is used, where 'HH' is hours, 'MM' is minutes, and 'SS' is seconds. A sample value is '05:00:00', which would mean that the recurring job would be executed at 5 AM GMT. This field is always required if the dailyRecurrence container is used. |
recurringJobDetail .downloadJobType |
token | Always |
Specifies the report you want to download. Each Bulk Data Exchange job can only have one job type per job. For instance, if you are downloading a SoldReport, it will only have predefined SoldReport data within the file.
|
recurringJobDetail .frequencyInMinutes |
int | Conditionally | This field is only returned if an intraday frequency was set up for the recurring job. If an intraday frequency is set up for a recurring job, job instances will be executed according to the frequency (in minutes) set in the frequencyInMinutes field. |
recurringJobDetail.jobStatus | RecurringJobStatus | Always |
The current state of a recurring Bulk Data Exchange job.
Applicable values: |
recurringJobDetail .monthlyRecurrence |
MonthlyRecurrence | Conditionally | This container is only returned if a monthly recurrence was set up for the recurring job. If a recurring job is set up to run on a monthly basis, the day of month and the time of day is returned under the monthlyRecurrence container. |
recurringJobDetail .monthlyRecurrence.dayOfMonth |
token | Conditionally |
This value is used to specify which day of each month that the recurring job should be executed. Supported values are 'Day_1', 'Day_2', 'Day_3', and all the way up to 'Day_28'. 'Day_Last' is also a supported value and indicates that the recurring job should be executed on the last day of each month, whether that be the 28th (in February), the 29th (in February during a leap year), the 30th, or 31st. 'Day_29', 'Day_30', and 'Day_31' are NOT supported values. This field is always required if the monthlyRecurrence container is used. |
recurringJobDetail .monthlyRecurrence.timeOfDay |
time | Conditionally |
This value is used to specify the time of day (on the day specified through the dayOfMonth field) that the job will execute. The 24-hour clock and GMT are used. 'HH:MM:SS' is the convention that is used, where 'HH' is hours, 'MM' is minutes, and 'SS' is seconds. A sample value is '05:00:00', which would mean that the recurring job would be executed at 5 AM GMT. This field is always required if the monthlyRecurrence container is used. |
recurringJobDetail .recurringJobId |
string | Always | The unique identifier of a recurring job that is assigned by the Bulk Data Exchange API after a successful createRecurringJob b> call. This value is passed into the request of other recurring job calls of the File Transfer API. |
recurringJobDetail .weeklyRecurrence |
WeeklyRecurrence | Conditionally | This container is only returned if a weekly recurrence was set up for the recurring job. If a recurring job is set up to run on a weekly basis, the day of week and the time of day is returned under the weeklyRecurrence container. |
recurringJobDetail .weeklyRecurrence.dayOfWeek |
token | Conditionally |
This value is used to specify which day of the week that the recurring job should be executed. Supported values are 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', and 'Saturday'. This field is always required if the weeklyRecurrence container is used. |
recurringJobDetail .weeklyRecurrence.timeOfDay |
time | Conditionally |
This value is used to specify the time of day (on the day specified through the dayOfWeek field) that the job will execute. The 24-hour clock and GMT are used. 'HH:MM:SS' is the convention that is used, where 'HH' is hours, 'MM' is minutes, and 'SS' is seconds. A sample value is '05:00:00', which would mean that the recurring job would be executed at 5 AM GMT. This field is always required if the weeklyRecurrence container is used. |
Standard Output Fields |
ack | AckValue | Always |
Returns the acknowledgement of the call success or failure.
Applicable values: |
errorMessage | ErrorMessage | Conditionally | Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success. |
errorMessage.error | ErrorData | Conditionally,
repeatable: [0..*] |
Details about a single error. |
errorMessage.error.category | ErrorCategory | Conditionally |
There are three categories of errors: request errors, application errors, and system errors.
Applicable values: |
errorMessage.error.domain | string | Conditionally |
Name of the domain upon which the error occurred.
|
errorMessage.error.errorId | long | 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. |
errorMessage.error.exceptionId | token | Conditionally | Unique identifier for an exception associated with an error. |
errorMessage.error.message | string | Conditionally | A detailed description of the condition that resulted in the error. |
errorMessage.error.parameter | ErrorParameter (string) | Conditionally,
repeatable: [0..*] |
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.parameter [ attribute name ] |
string | Conditionally | Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. |
errorMessage.error.severity | ErrorSeverity | Conditionally |
Indicates whether the error caused the request to fail (Error) or not (Warning). If the request fails and the source of the problem is within the application (such as a missing required element), please 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, you 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. 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. Applicable values: |
errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain upon which the error occurred.
|
timestamp | dateTime | Always | This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. |
version | string | Always |
The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site. |
Input Output Change History |
New to making API calls? Please see Making an API 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.
Returns the processing status of all Bulk Data Exchange service recurring jobs submitted by the user who make this call.
Description
User megaonlinemerchant
wants to check the status of the weekly reports she requested, to see if they are ready to download. She can enter a request with no job type fields, to see the status of all of her recurring jobs, or she can put specific job types in her request to see the status of only the specified job types.
As a result of this call, megaonlinemerchant
will see a list of all the Bulk Data Exchange service jobs for each job type she specified in her request.
Input
In the following getRecurringJobs request sample, you will see that you can provide a date range (optional) and a job type (required).
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <getRecurringJobsRequest xmlns="http://www.ebay.com/marketplace/services"> <!--megaonlinemerchant is leaving this blank so she will receive job ids for all of her recurring jobs--> </getRecurringJobsRequest>
Output
The response includes a Success or Failure acknowledgement, a timestamp, the version number of the Bulk Data Exchange service, job ID, file reference ID, percentage of processing completed, and the number of errors during processing for each Bulk Data Exchange service recurring job of the type that was submitted by the user who makes this call.
XML format. Also available is the .txt version of this XML and the SOAP equivalent. <?xml version="1.0" encoding="utf-8"?> <getRecurringJobsResponse xmlns="http://www.ebay.com/marketplace/services"> <ack>Success</ack> <version>1.0.0</version> <timestamp>2008-11-05T03:47:52.124Z</timestamp> <recurringJobDetail> <recurringJobId>5000000102</recurringJobId> <creationTime>2008-10-28T16:13:05.000Z</creationTime> <frequencyInMinutes>180</frequencyInMinutes> <downloadJobType>SoldReport</downloadJobType> <jobStatus>Active</jobStatus> </recurringJobDetail> <recurringJobDetail> <recurringJobId>5000000701</recurringJobId> <creationTime>2008-11-04T20:44:36.000Z</creationTime> <frequencyInMinutes>120</frequencyInMinutes> <downloadJobType>ActiveInventoryReport</downloadJobType> <jobStatus>Active</jobStatus> </recurringJobDetail> </getRecurringJobsResponse>
Input Output Samples |
Change Date | Description |
---|---|
1.2.0 2009-04-01 |
|
1.0.0 2008-11-29 |
|
Copyright © 2013–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.