1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Expense Travel Itineraries
  4. Expense Travel Itinerary Reservations

Get all travel itinerary reservations

get

/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the travel itinerary reservation record that matches the primary key criteria specified.
      Finder Variables
      • ItineraryReservationId; integer; The unique identifier of the travel itinerary reservation.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AddressLine1; string; First line of address information for hotel or vehicle rental reservation.
    • AddressLine2; string; Second line of address information for hotel or vehicle rental reservation.
    • AddressLine3; string; Third line of address information for hotel or vehicle rental reservation.
    • AddressLine4; string; Fourth 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; Confirmation 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; First contact number for hotel or vehicle rental reservation.
    • ContactNumber2; string; Second contact number for hotel or vehicle rental reservation.
    • ContactNumber3; string; Third contact number for hotel or vehicle rental reservation.
    • ContactNumber4; string; Fourth contact number for hotel or vehicle rental reservation.
    • CreatedBy; string; User who created the row.
    • CreationDate; string; Date and time when the row was created.
    • CurrencyCode; string; Currency of reservation amount.
    • EndDateTime; string; Checkout date and time for hotel reservation and drop-off time for vehicle rental.
    • HotelCity; string; City in which the hotel is located. The reservation is made at this hotel.
    • HotelCode; string; Hotel code for the hotel reservation.
    • HotelCountry; string; Country in which the hotel is located. The reservation is made at this hotel.
    • HotelCountryCode; string; Code of the country in which the hotel is located. The reservation is made at this hotel.
    • HotelLocationCode; string; Global Distribution System code of hotel location.
    • HotelState; string; State or province in which the hotel is located. The reservation is made at this hotel.
    • HotelStateCode; string; Code of state or province in which the hotel is located. The reservation is made at this hotel.
    • ItineraryReservationId; integer; The unique identifier of a reservation in a travel itinerary.
    • LastUpdateDate; string; Date and time when the row was last updated.
    • LastUpdateLogin; string; Session login associated with the user who last updated the row.
    • LastUpdatedBy; string; User who last updated the row.
    • LowerAmount; number; Lowest amount available in the booking tool that wasn't chosen by employee.
    • MerchantCode; string; Merchant code for hotel chain or car rental agency.
    • MerchantName; string; Merchant name for hotel or car rental agency.
    • NumberOfGuests; integer; Number of guests for the hotel reservation.
    • NumberOfRooms; integer; Number of hotel rooms for the hotel reservation.
    • PickupCity; string; Pickup city for vehicle rental reservation.
    • PickupCountry; string; Pickup country for vehicle rental reservation.
    • PickupCountryCode; string; Pickup country code for vehicle rental reservation.
    • PickupLocationCode; string; Global distribution system code of pickup location for vehicle rental.
    • PickupState; string; Pickup state or province for vehicle rental reservation.
    • PickupStateCode; string; Code of pickup state or province for vehicle rental reservation.
    • PolicyJustification; string; Policy violation justification text provided by employee while booking the reservation.
    • PolicyViolation; string; Policy violation text displayed to employee while booking the reservation.
    • PrepaidFlag; boolean; Indicates whether the reservation in a travel itinerary is prepaid.
    • RateDetails; string; Details provided by the hotel for the hotel reservation.
    • ReservationType; string; Type of reservation such as air, hotel, rail or vehicle rental.
    • ReturnCity; string; Return city for vehicle rental reservation.
    • ReturnCountry; string; Return country for vehicle rental reservation.
    • ReturnCountryCode; string; Return country code for vehicle rental reservation.
    • ReturnLocationCode; string; Global distribution system code of return location for vehicle rental.
    • ReturnState; string; Return state or province for vehicle rental reservation.
    • ReturnStateCode; string; Return state or province code for vehicle rental reservation.
    • RoomCode; string; Hotel room type for the hotel reservation.
    • StartDateTime; string; Check-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; The unique identifier of an itinerary for a reservation.
    • VehicleType; string; Vehicle type for vehicle rental reservation.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : expenseTravelItineraries-itineraryReservations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseTravelItineraries-itineraryReservations-item-response
Type: object
Show Source
Nested Schema : Expense Travel Itinerary Reservation Items
Type: array
Title: Expense Travel Itinerary Reservation Items
The expense reservation items resource is used to get travel reservation item information from third-party travel partner sites.
Show Source
Nested Schema : expenseTravelItineraries-itineraryReservations-reservationItems-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all the travel itinerary reservations from a specific 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/300100211867023/child/itineraryReservations

Example Response Body

The following example shows the contents of the response body in JSON format:

{
	"items": [
	{
		"ItineraryReservationId": 300100211375832,
		"HotelLocationCode": null,
		"PickupLocationCode": "JFK",
		"ReturnLocationCode": "JFK",
		"TravelItineraryId": 300100211375831,
		"ConfirmationNumber": "BASDFGHAA",
		"ReservationType": "Vehicle Rental",
		"CurrencyCode": "USD",
		"Amount": 350,
		"TotalTax": null,
		"TotalAmount": 350,
		"LowerAmount": null,
		"MerchantCode": "CP",
		"MerchantName": "Crowne Plaza",
		"HotelCode": null,
		"StartDateTime": "2020-11-01T12:35:00",
		"EndDateTime": "2020-11-06T12:35:00",
		"NumberOfRooms": null,
		"RoomCode": null,
		"BaseRate": null,
		"RateDetails": null,
		"NumberOfGuests": null,
		"AddressLine1": null,
		"AddressLine2": null,
		"AddressLine3": null,
		"AddressLine4": null,
		"ContactNumber1": null,
		"ContactNumber2": null,
		"ContactNumber3": null,
		"ContactNumber4": null,
		"HotelCity": null,
		"HotelState": null,
		"HotelStateCode": null,
		"HotelCountry": null,
		"HotelCountryCode": null,
		"VehicleType": "LARGE",
		"PickupCity": "Englewood",
		"PickupState": "New Jersey",
		"PickupStateCode": "NJ",
		"PickupCountry": "USA",
		"PickupCountryCode": "US",
		"ReturnCity": "New York",
		"ReturnState": "NEW YORK",
		"ReturnStateCode": "JFX",
		"ReturnCountry": "USA",
		"ReturnCountryCode": "US",
		"PolicyViolation": null,
		"PolicyJustification": null,
		"CreationDate": "2020-10-30T08:44:18.052+00:00",
		"CreatedBy": "travel.admin1@oracle.com",
		"LastUpdateDate": "2020-11-12T19:36:55.391+00:00",
		"LastUpdatedBy": "travel.admin1@oracle.com",
		"LastUpdateLogin": "B3EB3FFE6103CFE2E0532988F40ADFC9",
		"CancelledFlag": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375832",
			"name": "itineraryReservations",
			"kind": "item",
			"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375832",
			"name": "itineraryReservations",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831",
			"name": "expenseTravelItineraries",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375832/child/reservationItems",
			"name": "reservationItems",
			"kind": "collection"
		}  ]
	},
	{
		"ItineraryReservationId": 300100211375833,
		"HotelLocationCode": null,
		"PickupLocationCode": null,
		"ReturnLocationCode": null,
		"TravelItineraryId": 300100211375831,
		"ConfirmationNumber": "BASDFGHAB",
		"ReservationType": "Hotel",
		"CurrencyCode": "USD",
		"Amount": 600,
		"TotalTax": null,
		"TotalAmount": 600,
		"LowerAmount": null,
		"MerchantCode": "CP",
		"MerchantName": "Crowne Plaza Englewood",
		"HotelCode": null,
		"StartDateTime": "2020-11-01T12:35:00",
		"EndDateTime": "2020-11-06T12:35:00",
		"NumberOfRooms": 2,
		"RoomCode": null,
		"BaseRate": 120,
		"RateDetails": null,
		"NumberOfGuests": 2,
		"AddressLine1": "21425",
		"AddressLine2": "hsjfjfj",
		"AddressLine3": "sdghj",
		"AddressLine4": "New York",
		"ContactNumber1": "436475869",
		"ContactNumber2": "2423645879",
		"ContactNumber3": "43564758",
		"ContactNumber4": "242364589",
		"HotelCity": "New York",
		"HotelState": "NEW YORK",
		"HotelStateCode": "JFX",
		"HotelCountry": "USA",
		"HotelCountryCode": "US",
		"VehicleType": null,
		"PickupCity": null,
		"PickupState": null,
		"PickupStateCode": null,
		"PickupCountry": null,
		"PickupCountryCode": null,
		"ReturnCity": null,
		"ReturnState": null,
		"ReturnStateCode": null,
		"ReturnCountry": null,
		"ReturnCountryCode": null,
		"PolicyViolation": null,
		"PolicyJustification": null,
		"CreationDate": "2020-10-30T08:44:18.059+00:00",
		"CreatedBy": "travel.admin1@oracle.com",
		"LastUpdateDate": "2020-11-12T19:36:55.394+00:00",
		"LastUpdatedBy": "travel.admin1@oracle.com",
		"LastUpdateLogin": "B3EB3FFE6103CFE2E0532988F40ADFC9",
		"CancelledFlag": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375833",
			"name": "itineraryReservations",
			"kind": "item",
			"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001678"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375833",
			"name": "itineraryReservations",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831",
			"name": "expenseTravelItineraries",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations/300100211375833/child/reservationItems",
			"name": "reservationItems",
			"kind": "collection"
			} ]
		}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100211375831/child/itineraryReservations",
		"name": "itineraryReservations",
		"kind": "collection"
	}
	]
}
Back to Top