ItineraryProvider Service

An API to interact with itineraries / trips. This will have two types of complicated return objects: The first will be the itinerary summary straight from the database. The second would be a display object that has detailed trip information.

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/ItineraryProviderService

getFutureItinerariesForLoggedInUser Operation

Get the latest X itineraries for the logged in user.

Input Parameters
name type description
max int  
Return Value
type description
list of itinerary The latest X itineraries for the logged in user.

getNextFutureSegment Operation

Input Parameters
name type description
itineraryId long  
Return Value
type description
displaySegment  

searchItinerariesForLoggedInUser Operation

Search within all itineraries that this user has.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
list of passengerInformation The trips received from the search.

countItinerariesForLoggedInUser Operation

Search within all itineraries that his user has for a total count.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
long The total count of trips received from the search.

searchItineraries Operation

Search within all itineraries that this user can view.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
list of passengerInformation The trips received from the search.

findRepairableItineraries Operation

Find all itineraries that are not assigned to (a) passenger(s)

Input Parameters
name type description
passengerInformationId long The id of the PassengerInformation from which to get comparison data
userId long Exclude all PassengerInformation results with this id
matchLevel int The level of matching to perform: 0 = full name, 1 = email, 2 = last name, 3 = first name, 4 = none
startIndex int The position to start searching from for the given match level
maxResults int The number of results to return
Return Value
type description
repairableItineraryResults All itineraries that are not assigned to (a) passenger(s)

searchItinerariesSimple Operation

Get a simple itinerary. A typical simple itinerary will only have the name, date, etc.

Input Parameters
name type description
searchList searchList The query to get simple itineraries for.
Return Value
type description
list of simplePassenger A list of simple itineraries.

searchExtendedItinerariesSimple Operation

Get a simple itinerary with extended properties. A typical simple itinerary will only have the name, date, etc. While the extended version will contain the profile info.

Input Parameters
name type description
searchList searchList The query to get extended simple itineraries for.
Return Value
type description
list of simplePassenger A list of simple itineraries with extended properties.

searchLastExtendedItinerariesSimple Operation

Get a simpleitinerary with extended properties. A typical simple itinerary will only have the name, date, etc. While the extended version will contain the profile info.

Input Parameters
name type description
searchList searchList The query to get simple itineraries for.
Return Value
type description
list of simplePassenger A list of simple itineraries with extended properties.

searchExtendedItinerariesSimpleForLoggedInUser Operation

Get a simple itinerary with extended properties. A typical simple itinerary will only have the name, date, etc. While the extended version with contain the profile info.

Input Parameters
name type description
searchList searchList The query to get extended simple itieneraries for.
Return Value
type description
list of simplePassenger A list of simple itineraries with extended properties.

getActiveTravelers Operation

Get a list of all travelers currently traveling

Input Parameters
name type description
clientId long  
Return Value
type description
list of passengerInformation list of Passenger Information

getAvailableItineraryFilters Operation

Get the available filters that we can search for itineraries by.

Return Value
type description
list of filterItem The available filters that we can search for itineraries with.

countItineraries Operation

Search within all itineraries that this user can view.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
long The total count of trips received from the search.

countLastItineraries Operation

Count all of the last itinerary updates.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
long The total count of trips updated within the search.

importItinerary Operation

Import a record locator into Airportal from the provided GDS.

See Also
GlobalDistributionSystem
Input Parameters
name type description
recordLocator string The record locator to import into Airportal.
gdsCode string The GDS that this record locator is in. This is the BCD code.
Return Value
type description
importAnalytic  

importHiddenItinerary Operation

Import a record locator into Airportal, but do NOT refresh the indexes or notify other projects.

Input Parameters
name type description
locator string The record locator to import into Airportal.
gds string The GDS that this record locator is in. This is the BCD code.
Return Value
type description
importAnalytic An analytic with the status on whether the import was successful or not.

importItineraryNoInvoice Operation

Import a record locator into Airportal, but do NOT import the invoice from the GDS.

Input Parameters
name type description
locator string The record locator to import into Airportal.
gds string The GDS that this record locator is in. This is the BCD code.
Return Value
type description
importAnalytic An analytic with the status on whether the import was successful or not.

cancelItinerary Operation

Mark a record locator as canceled in Airportal. This will mark it's tickets as canceled in AirBank as well as mark it as hidden from view by travelers and travel managers.

See Also
GlobalDistributionSystem
Input Parameters
name type description
recordLocator string The record locator to hide.
gdsCode string The GDS that this record locator is in. This is to remove chances of duplicates.

refreshItineraries Operation

Refreshes itineraries returned by the given search list.

Input Parameters
name type description
searchList searchList The searchList object that describes how to search for trips.
Return Value
type description
string String whether all the itineraries were refreshed, will be false if any one failed.

refreshUserItineraries Operation

Refreshes itineraries returned by searching using the user. It limits the number of itineraries refreshed by 100, ordered by departure date.

Input Parameters
name type description
userid long The id of the user to refresh itineraries for.
Return Value
type description
string String whether all the itineraries were refreshed, will be false if any one failed.

updateImportAnalytic Operation

Update an ImportAnalytic

Input Parameters
name type description
analytic importAnalytic The ImportAnalytic to update
Return Value
type description
importAnalytic The resolved error report.

updatePassengerInformation Operation

Update the passenger information Note: Prod Util - UnassignAirtineraryByClient (Used by Production supoort team)

Input Parameters
name type description
info passengerInformation The passenger information object
Return Value
type description
passengerInformation the updated passenger information

hideItinerary Operation

Hide an itinerary. This will not hide all histories of this itinerary!

Input Parameters
name type description
id long The id of the itinerary to hide.
Return Value
type description
string  

unHideItinerary Operation

Show an itinerary. This will not show all histories of this itinerary!

Input Parameters
name type description
id long The id of the itinerary to show.
Return Value
type description
string  

updatePassengerUser Operation

Update ONLY the profile for a user and update the views for that itinerary.

Input Parameters
name type description
info passengerInformation The passengerinformation object to update. The only field that is read will be the user field.

getPrimaryPassenger Operation

Get the first passenger on the itinerary

Input Parameters
name type description
itineraryId long  
Return Value
type description
passengerInformation PassengerInformation

getTravelerById Operation

Input Parameters
name type description
id long  
Return Value
type description
passengerInformation  

saveDisplayItineraryAsItinerary Operation

Populate an itinerary based upon the display itinerary and persist to database

Input Parameters
name type description
displayItinerary displayItinerary  
Return Value
type description
itinerary Itinerary

searchImportAnalytics Operation

Get analytics for all users.

Input Parameters
name type description
search searchList The query to search for.
Return Value
type description
list of simpleImport A list of import analytics.

countImportAnalytics Operation

Get a count of total analytics for all users.

Input Parameters
name type description
search searchList The query to get a count of.
Return Value
type description
long A long value that is the total records expected.

getImportAnalytic Operation

Get an ImportAnalytic by it's ID.

Input Parameters
name type description
id long The ID of the import analytic.
Return Value
type description
importAnalytic The Import analytic represented by the ID.