Allows a partner to retrieve a List of EdiBatch objects for a single batch number, a range of batch numbers, or a range of dates.
name | description | type | default | type |
---|---|---|---|---|
partnerId | string indicating which partner's data should be retrieved | query | String | |
altPartnerId | string indicating which partner's data should be retrieved | query | String | |
version | string indicating the version of the data to be retrieved | query | String | |
transactionSet | string indicating the type of transaction set to be retrieved | query | String | |
batch | integer indicating a single batch number to be retrieved | query | int | |
beginBatch | integer indicating the beginning of the batch number range (both begin and end batch numbers must be specified if a range is desired) | query | int | |
endBatch | integer indicating the end of the batch number range (both begin and end batch numbers must be specified if a range is desired) | query | int | |
beginDate | date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) | query | Date | |
endDate | date/time indicating the beginning of the date range (both begin and end dates must be specified if a date range is desired) | query | Date | |
createLog | query | Boolean |
a list of EdiBatch objects
Additional attributes:
__eventTypeDescr
This value represents the event type description, found in the edistatus.event_type
field.__stopTypeDescr
This value represents the stop type description, found in the edistatus.curr_stop_type
field.