Get all travel itineraries

get

/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries

Request

Query Parameters
  • 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 record that matches the primary key criteria specified.
      Finder Variables
      • TravelItineraryId; integer; The unique identifier of the travel itinerary.
  • 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:
    • BookingDateTime; string; 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; User who created the row.
    • CreationDate; string; Date and time when the row was created.
    • EmployeeNumber; string; Employee number of traveler in the reservation.
    • FirstName; string; First name of traveler in the reservation.
    • ItineraryRecordLocator; string; Travel 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.
    • LastName; string; Last name of traveler in the reservation.
    • 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.
    • StatusCode; string; Status 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; Unique identifier of a travel itinerary.
    • TravelPartnerName; string; Name of the travel partner with which the integration is associated.
    • TravelPartnerTripNumber; string; Trip in the travel partner's system with which travel itinerary is associated.
    • TripId; integer; The unique identifier for a trip.
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseTravelItineraries-item-response
Type: object
Show Source
Nested Schema : Expense Travel Itinerary Reservations
Type: array
Title: Expense Travel Itinerary Reservations
The expense itinerary reservations resource is used to get travel reservation information from third-party travel partner sites.
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 itineraries 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

Example Response Body

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

{
	"items": [
	{
		"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"
		} ]
	},
	{
		"TravelItineraryId": 300100210878584,
		"TravelPartnerTripNumber": "4.145696",
		"ItineraryRecordLocator": "4",
		"TripId": null,
		"StatusCode": "Active",
		"FirstName": "Mary",
		"LastName": "Johnson",
		"EmployeeNumber": "10026335772",
		"BookingDateTime": "2020-11-15T02:09:51+00:00",
		"CreationDate": "2020-10-27T08:40:51+00:00",
		"CreatedBy": "travel.admin1@oracle.com",
		"LastUpdateDate": "2020-10-27T08:40:51.154+00:00",
		"LastUpdatedBy": "travel.admin1@oracle.com",
		"LastUpdateLogin": "B2341C96419FB342E053D9B1F20AD9D0",
		"TravelPartnerName": "Oracletravel.com",
		"BookingSiteName": "TravelBookings1",
		"links": [
		{
			"rel": "self",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210878584",
			"name": "expenseTravelItineraries",
			"kind": "item",
			"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210878584",
			"name": "expenseTravelItineraries",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/300100210878584/child/itineraryReservations",
			"name": "itineraryReservations",
			"kind": "collection"
		} ]
	},
	...
	],
		"count": 4,
		"hasMore": false,
		"limit": 25,
		"offset": 0,
		"links": [
		{
			"rel": "self",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTravelItineraries",
			"name": "expenseTravelItineraries",
			"kind": "collection"
		}
		]
}
Back to Top