Get a Stop
get
/trackingEvents/{iTransactionNo}/stops/{iRecNo}
Request
Path Parameters
-
iRecNo(required): string
Resource ID
-
iTransactionNo(required): string
Resource ID
Query Parameters
-
expand: string
Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=singular
Default Response
Default Response.
Root Schema : schema
Type:
Show Source
object
-
aeiIndicator: string
The AEI indicator for the tracking event.
-
domainName: string
Database domain where this data is stored.
-
erpc: string
If the tracking stop is for a rail location the Eastern Railroad President's Conference (ERPC) can be used.
-
eventCity: string
The city associated with the tracking event.
-
eventCountry: string
The country associated with the tracking event.
-
eventdate:
eventdate
The tracking event date.
-
eventState: string
The state associated with the tracking event.
-
gatePierDoorNumber: string
The gate pier door number assigned to the shipment tracking status.
-
iRecNo: number
(int64)
The record number primary key identifier for the tracking event specified.
-
latitude: string
A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
-
links: array
links
Read Only:
true
-
locationGid: string
Typically a location GID is not supplied on a stop tracking event if you have entered the stop sequence number. If adding an additional stop to the shipment, this field together with the reference position is required.
-
locationIdValue: string
The location reference value associated with the reference number qualifier.
-
locationName: string
A location name if supplied with the tracking event.
-
locationRefnumQualGid: string
The location reference number quantifier associated with a location reference number if supplied on the tracking event.
-
longitude: string
A latitude and longitude value for a stop level tracking event can be supplied instead of a location based event.
-
portLocationFunctionCode: string
The port location function code for ocean tracking events.
-
referencePosition: string
The position of this stop relative to the yet-to-be-created new stop.
-
splcCode: string
If the tracking stop is for a rail location the Standard Point Location Code (SPLC) can be used.
-
stopSequence: number
(int32)
The stop sequence associated with the stop if a shipment identifier is entered and stop tracking event is for an existing stop.
-
stopType: string
The stop type for the new stop created with tracking event.
-
terminalName: string
The terminal name for port associated with the tracking event status.
-
timeZoneGid: string
The time zone identifier for the tracking event.
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format