Get a travel itinerary
get
/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}
Request
Path Parameters
-
expenseTravelItinerariesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Expense Travel Itineraries resource and used to uniquely identify an instance of Expense Travel Itineraries. The client should not generate the hash key value. Instead, the client should query on the Expense Travel Itineraries collection resource in order to navigate to a specific instance of Expense Travel Itineraries to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : expenseTravelItineraries-item-response
Type:
Show Source
object-
BookingDateTime: string
(date-time)
Date and time in UTC when the itinerary is created or modified in the global distribution system or travel partner system.
-
BookingSiteName: string
Name of travel partner booking site.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
EmployeeNumber: string
Maximum Length:
64Employee number of traveler in the reservation. -
FirstName: string
Maximum Length:
120First name of traveler in the reservation. -
ItineraryRecordLocator: string
Maximum Length:
32Travel itinerary in the travel partner's system, which is passenger name record for itineraries booked from global distribution system or rail confirmation number for rail itineraries. -
itineraryReservations: array
Expense Travel Itinerary Reservations
Title:
Expense Travel Itinerary ReservationsThe expense itinerary reservations resource is used to get travel reservation information from third-party travel partner sites. -
LastName: string
Maximum Length:
120Last name of traveler in the reservation. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StatusCode: string
Maximum Length:
30Status of imported travel itinerary, such as Active for itineraries that don't contain air or rail reservations, Ticketed for itineraries that contain air or rail itineraries, and Canceled for itineraries that are canceled. -
TravelItineraryId: integer
(int64)
Unique identifier of a travel itinerary.
-
TravelPartnerName: string
Name of the travel partner with which the integration is associated.
-
TravelPartnerTripNumber: string
Maximum Length:
32Trip in the travel partner's system with which travel itinerary is associated. -
TripId: integer
(int64)
The unique identifier for a trip.
Nested Schema : Expense Travel Itinerary Reservations
Type:
arrayTitle:
Expense Travel Itinerary ReservationsThe expense itinerary reservations resource is used to get travel reservation information from third-party travel partner sites.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : expenseTravelItineraries-itineraryReservations-item-response
Type:
Show Source
object-
AddressLine1: string
Maximum Length:
240First line of address information for hotel or vehicle rental reservation. -
AddressLine2: string
Maximum Length:
240Second line of address information for hotel or vehicle rental reservation. -
AddressLine3: string
Maximum Length:
240Third line of address information for hotel or vehicle rental reservation. -
AddressLine4: string
Maximum Length:
240Fourth line of address information for hotel or vehicle rental reservation. -
Amount: number
Reservation amount which doesn't include tax.
-
BaseRate: number
Daily base rate for hotel reservation.
-
CancelledFlag: boolean
Indicates whether the reservation is canceled. When this value is set to Y the reservation gets removed from the itinerary.
-
ConfirmationNumber: string
Maximum Length:
32Confirmation number for hotel and vehicle rental reservations. Null for air and rail reservations because confirmation number is stored for them at the reservation item level. -
ContactNumber1: string
Maximum Length:
16First contact number for hotel or vehicle rental reservation. -
ContactNumber2: string
Maximum Length:
16Second contact number for hotel or vehicle rental reservation. -
ContactNumber3: string
Maximum Length:
16Third contact number for hotel or vehicle rental reservation. -
ContactNumber4: string
Maximum Length:
16Fourth contact number for hotel or vehicle rental reservation. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
CurrencyCode: string
Maximum Length:
15Currency of reservation amount. -
EndDateTime: string
Maximum Length:
32Checkout date and time for hotel reservation and drop-off time for vehicle rental. -
HotelCity: string
Maximum Length:
64City in which the hotel is located. The reservation is made at this hotel. -
HotelCode: string
Maximum Length:
30Hotel code for the hotel reservation. -
HotelCountry: string
Maximum Length:
64Country in which the hotel is located. The reservation is made at this hotel. -
HotelCountryCode: string
Maximum Length:
64Code of the country in which the hotel is located. The reservation is made at this hotel. -
HotelLocationCode: string
Maximum Length:
30Global Distribution System code of hotel location. -
HotelState: string
Maximum Length:
64State or province in which the hotel is located. The reservation is made at this hotel. -
HotelStateCode: string
Maximum Length:
64Code of state or province in which the hotel is located. The reservation is made at this hotel. -
ItineraryReservationId: integer
(int64)
The unique identifier of a reservation in a travel itinerary.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LowerAmount: number
Lowest amount available in the booking tool that wasn't chosen by employee.
-
MerchantCode: string
Maximum Length:
30Merchant code for hotel chain or car rental agency. -
MerchantName: string
Maximum Length:
120Merchant name for hotel or car rental agency. -
NumberOfGuests: integer
(int32)
Number of guests for the hotel reservation.
-
NumberOfRooms: integer
(int32)
Number of hotel rooms for the hotel reservation.
-
PickupCity: string
Maximum Length:
64Pickup city for vehicle rental reservation. -
PickupCountry: string
Maximum Length:
64Pickup country for vehicle rental reservation. -
PickupCountryCode: string
Maximum Length:
64Pickup country code for vehicle rental reservation. -
PickupLocationCode: string
Maximum Length:
30Global distribution system code of pickup location for vehicle rental. -
PickupState: string
Maximum Length:
64Pickup state or province for vehicle rental reservation. -
PickupStateCode: string
Maximum Length:
64Code of pickup state or province for vehicle rental reservation. -
PolicyJustification: string
Maximum Length:
240Policy violation justification text provided by employee while booking the reservation. -
PolicyViolation: string
Maximum Length:
240Policy violation text displayed to employee while booking the reservation. -
PrepaidFlag: boolean
Maximum Length:
1Indicates whether the reservation in a travel itinerary is prepaid. -
RateDetails: string
Maximum Length:
240Details provided by the hotel for the hotel reservation. -
reservationItems: array
Expense Travel Itinerary Reservation Items
Title:
Expense Travel Itinerary Reservation ItemsThe expense reservation items resource is used to get travel reservation item information from third-party travel partner sites. -
ReservationType: string
Maximum Length:
30Type of reservation such as air, hotel, rail or vehicle rental. -
ReturnCity: string
Maximum Length:
64Return city for vehicle rental reservation. -
ReturnCountry: string
Maximum Length:
64Return country for vehicle rental reservation. -
ReturnCountryCode: string
Maximum Length:
20Return country code for vehicle rental reservation. -
ReturnLocationCode: string
Maximum Length:
30Global distribution system code of return location for vehicle rental. -
ReturnState: string
Maximum Length:
64Return state or province for vehicle rental reservation. -
ReturnStateCode: string
Maximum Length:
64Return state or province code for vehicle rental reservation. -
RoomCode: string
Maximum Length:
30Hotel room type for the hotel reservation. -
StartDateTime: string
Maximum Length:
32Check-in date and time for hotel reservation and pickup time for vehicle rental. -
TotalAmount: number
Total reservation amount which includes tax.
-
TotalTax: number
Tax on reservation amount.
-
TravelItineraryId: integer
(int64)
The unique identifier of an itinerary for a reservation.
-
VehicleType: string
Maximum Length:
32Vehicle type for vehicle rental reservation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Expense Travel Itinerary Reservation Items
Type:
arrayTitle:
Expense Travel Itinerary Reservation ItemsThe expense reservation items resource is used to get travel reservation item information from third-party travel partner sites.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : expenseTravelItineraries-itineraryReservations-reservationItems-item-response
Type:
Show Source
object-
AircraftTypeCode: string
Maximum Length:
30Global distribution system aircraft type code for airplane used in a flight. -
ArrivalCity: string
Maximum Length:
64Arrival city for airport or train station. -
ArrivalCountry: string
Maximum Length:
64Arrival country for airport or train station. -
ArrivalCountryCode: string
Maximum Length:
30Arrival country code for airport or train station. -
ArrivalDateTime: string
Maximum Length:
32Arrival date and time in arrival city. -
ArrivalLocationCode: string
Maximum Length:
30Arrival airport or train station code. -
ArrivalLocationName: string
Maximum Length:
80Arrival airport or train station name. -
ArrivalState: string
Maximum Length:
64Arrival state or province name for airport or train station. -
ArrivalStateCode: string
Maximum Length:
30Arrival state or province code for airport or train station. -
CancelledFlag: boolean
Indicates whether the reservation item is canceled. When this value is set to Y the reservation item gets removed from the itinerary.
-
ConnectionTypeCode: string
Maximum Length:
30Connection indicator for nondirect travel segments such as O for outbound, I for inbound, IO for inbound and outbound connecting stops. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
DepartureCity: string
Maximum Length:
64Departure city name for airport or train station. -
DepartureCountry: string
Maximum Length:
64Departure country for airport or train station. -
DepartureCountryCode: string
Maximum Length:
30Departure country code for airport or train station. -
DepartureDateTime: string
Maximum Length:
32Departure date and time in departure city local time. -
DepartureLocationCode: string
Maximum Length:
30Global distribution system code for departure airport or train station. -
DepartureLocationName: string
Maximum Length:
80Departure airport or train station name. -
DepartureState: string
Maximum Length:
64Departure state or province name for airport or train station. -
DepartureStateCode: string
Maximum Length:
30Departure state or province code for airport or train station. -
FareClass: string
Maximum Length:
64Travel fare class of the seat on the flight. -
FlightNumber: string
Maximum Length:
16Flight number for air travel segment. -
ItemConfirmationNumber: string
Maximum Length:
32Confirmation number of AIR or RAIL reservation at the travel segment level. -
ItineraryReservationId: integer
(int64)
The unique identifier of an air or rail reservation to which a travel segment belongs.
-
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MarketAirlineCode: string
Maximum Length:
30Global distribution system marketing airline code for a flight. -
NumberInParty: integer
(int32)
Number of travelers in the party.
-
OperatingAirlineCode: string
Maximum Length:
30Global distribution system operating airline code for a flight. -
OperatingAirlineName: string
Maximum Length:
120Operating airline name for a flight. -
PolicyViolation: string
Maximum Length:
240Policy violation text displayed to the employee while booking the reservation. -
RailVendorCode: string
Maximum Length:
30Global distribution system code for the rail carrier. -
ReservationGlobalDistributionCode: string
Maximum Length:
30Global distribution code for the reservation or booking. -
ReservationItemId: integer
(int64)
The unique identifier of a travel segment for an AIR or RAIL reservation.
-
TrainNumber: string
Maximum Length:
16Train number for rail travel segment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- itineraryReservations
-
Parameters:
- expenseTravelItinerariesUniqID:
$request.path.expenseTravelItinerariesUniqID
The expense itinerary reservations resource is used to get travel reservation information from third-party travel partner sites. - expenseTravelItinerariesUniqID:
Examples
The following example shows how to retrieve a travel itinerary by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210661601
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"TravelItineraryId": 300100210661601,
"TravelPartnerTripNumber": "1.145696",
"ItineraryRecordLocator": "1",
"TripId": 300100210663567,
"StatusCode": "Active",
"FirstName": "Mary",
"LastName": "Johnson",
"EmployeeNumber": "10026335772",
"BookingDateTime": "2020-11-15T02:09:51+00:00",
"CreationDate": "2020-10-22T09:03:42+00:00",
"CreatedBy": "travel.admin1@oracle.com",
"LastUpdateDate": "2020-10-22T09:05:06.047+00:00",
"LastUpdatedBy": "travel.admin1@oracle.com",
"LastUpdateLogin": "B23FB1E0D9A4CE76E053D9B1F20A4FBE",
"TravelPartnerName": "Oracletravel.com",
"BookingSiteName": "TravelBookings1",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210661601",
"name": "expenseTravelItineraries",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210661601",
"name": "expenseTravelItineraries",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210661601/child/itineraryReservations",
"name": "itineraryReservations",
"kind": "collection"
}
]
}