Get all travel itinerary reservation items

get

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

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.
  • This is the hash key of the attributes which make up the composite key for the Expense Travel Itinerary Reservations resource and used to uniquely identify an instance of Expense Travel Itinerary Reservations. The client should not generate the hash key value. Instead, the client should query on the Expense Travel Itinerary Reservations collection resource in order to navigate to a specific instance of Expense Travel Itinerary Reservations 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 item record that matches the primary key criteria specified.
      Finder Variables
      • ReservationItemId; integer; The unique identifier of the travel itinerary reservation item.
  • 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:
    • AircraftTypeCode; string; Global distribution system aircraft type code for airplane used in a flight.
    • ArrivalCity; string; Arrival city for airport or train station.
    • ArrivalCountry; string; Arrival country for airport or train station.
    • ArrivalCountryCode; string; Arrival country code for airport or train station.
    • ArrivalDateTime; string; Arrival date and time in arrival city.
    • ArrivalLocationCode; string; Arrival airport or train station code.
    • ArrivalLocationName; string; Arrival airport or train station name.
    • ArrivalState; string; Arrival state or province name for airport or train station.
    • ArrivalStateCode; string; Arrival 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; Connection indicator for nondirect travel segments such as O for outbound, I for inbound, IO for inbound and outbound connecting stops.
    • CreatedBy; string; User who created the row.
    • CreationDate; string; Date and time when the row was created.
    • DepartureCity; string; Departure city name for airport or train station.
    • DepartureCountry; string; Departure country for airport or train station.
    • DepartureCountryCode; string; Departure country code for airport or train station.
    • DepartureDateTime; string; Departure date and time in departure city local time.
    • DepartureLocationCode; string; Global distribution system code for departure airport or train station.
    • DepartureLocationName; string; Departure airport or train station name.
    • DepartureState; string; Departure state or province name for airport or train station.
    • DepartureStateCode; string; Departure state or province code for airport or train station.
    • FareClass; string; Travel fare class of the seat on the flight.
    • FlightNumber; string; Flight number for air travel segment.
    • ItemConfirmationNumber; string; Confirmation number of AIR or RAIL reservation at the travel segment level.
    • ItineraryReservationId; integer; The unique identifier of an air or rail reservation to which a travel segment belongs.
    • 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.
    • MarketAirlineCode; string; Global distribution system marketing airline code for a flight.
    • NumberInParty; integer; Number of travelers in the party.
    • OperatingAirlineCode; string; Global distribution system operating airline code for a flight.
    • OperatingAirlineName; string; Operating airline name for a flight.
    • PolicyViolation; string; Policy violation text displayed to the employee while booking the reservation.
    • RailVendorCode; string; Global distribution system code for the rail carrier.
    • ReservationGlobalDistributionCode; string; Global distribution code for the reservation or booking.
    • ReservationItemId; integer; The unique identifier of a travel segment for an AIR or RAIL reservation.
    • TrainNumber; string; Train number for rail travel segment.
  • 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-reservationItems
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenseTravelItineraries-itineraryReservations-reservationItems-item-response
Type: object
Show Source
Back to Top