ContractsProvider Service

Contracts provider provides objects that describe relations between various business entities. For instance, a contract could be a negotiated relationship between an account and an airline to get a discounted rate. Created by nick on 4/4/16.

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

searchContracts Operation

Searches all client contracts.

Input Parameters
name type description
list searchList The search list to use.
Return Value
type description
list of clientContract A list of ClientContracts that are associated with the given search list

countContracts Operation

Counts all client contyracts.

Input Parameters
name type description
list searchList The search list to use.
Return Value
type description
long The number of ClientContracts that are associated with the given search list

setContractAsFavorite Operation

A function to update client vendor contracts as a favorite or not. This is used in REST.

Input Parameters
name type description
contractId long Id of the contract in question.
isFavorite string Whether the contract should be set asa s favorite. 'true' will set the contract as a favorite.
type string The type of contract. H/C/A are accepted, sending anything else will result in it being a MISC contract.

getClientContracts Operation

Gets all of the ClientContracts of all types, including AirClient, CarClient, etc., for this client

Input Parameters
name type description
clientId long The client id to get the ClientContracts for.
Return Value
type description
list of simpleClientContract A list of SimpleClientContracts that are associated with the given client id.

getExpiringClientContracts Operation

Gets all of the Expiring ClientContracts of all types, including AirClient, HotelClient, etc., for this client

Input Parameters
name type description
clientId long The client id to get the ClientContracts for.
Return Value
type description
list of displayName A list of DisplayName objects that are associated with the given client id.

getExpiringClientContractsCount Operation

Gets the count of all expiring/expired ClientContracts of all types, including AirClient, CarClient, etc

Input Parameters
name type description
userId long The user id to get the clients which the user manages
Return Value
type description
list of wt0TaskCount A list of Wt0TaskCounts

getClientOtherContractsById Operation

Gets the ClientContract objects for this client for misc vendor contracts.

Input Parameters
name type description
clientId long The client id to get the ClientContract for.
Return Value
type description
list of clientContract A list of ClientContracts that are associated with the given client id.

getClientAirContractsById Operation

Gets the AirClientContract objects for this client for air vendor contracts.

Input Parameters
name type description
clientId long The client id to get the ClientContract for.
Return Value
type description
list of airClientContract A list of AirClientContracts for the given clientId

getClientCarContractsById Operation

Gets the CarClientContract objects for this client for car vendor contracts.

Input Parameters
name type description
clientId long The client id to get the ClientContract for.
Return Value
type description
list of carClientContract A list of CarClientContracts for the given clientId

getClientHotelContractsById Operation

Gets the HotelClientContract objects for this client for hotel vendor contracts.

Input Parameters
name type description
clientId long The client id to get the ClientContract for.
Return Value
type description
list of hotelClientContract A list of HotelrClientContracts for the given clientId

getClientHotelChainContractsById Operation

Gets the HotelChainClientContract objects for this client for hotel chain vendor contracts.

Input Parameters
name type description
clientId long The client id to get the ClientContract for.
Return Value
type description
list of hotelChainClientContract A list of HotelChainClientContracts for the given clientId

getContractById Operation

Gets the ClientContract object by it's unique id.

Input Parameters
name type description
contractId long The contract id of the contract.
Return Value
type description
clientContract The ClientContract object associated by given id

getAirContractById Operation

Gets the AirClientContract object by it's unique id.

Input Parameters
name type description
contractId long The contract id of the contract.
Return Value
type description
airClientContract The AirClientContract object associated by given id

getCarContractById Operation

Gets the CarClientContract object by it's unique id.

Input Parameters
name type description
contractId long The contract id of the contract.
Return Value
type description
carClientContract The CarClientContract object associated by given id

getHotelContractById Operation

Gets the HotelClientContract object by it's unique id.

Input Parameters
name type description
contractId long The contract id of the contract.
Return Value
type description
hotelClientContract The HotelClientContract object associated by given id

getHotelChainContractById Operation

Gets the HotelChainClientContract object by its unique id.

Input Parameters
name type description
contractId long The contract id of the contract.
Return Value
type description
hotelChainClientContract The HotelChainClientContract object associated by given id

updateClientContract Operation

A function to update/create client vendor contracts.

Input Parameters
name type description
contract clientContract The contract to update
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
Return Value
type description
clientContract ClientContract object with violations if it did not update/create properly

updateAirClientContract Operation

A function to update air client vendor contracts.

Input Parameters
name type description
contract airClientContract The contract to update
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
Return Value
type description
airClientContract AirClientContract object with violations if did not update/create properly.

updateCarClientContract Operation

A function to update car client vendor contracts.

Input Parameters
name type description
contract carClientContract The contract to update
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
Return Value
type description
carClientContract CarClientContract object with violations if did not update/create properly.

updateHotelClientContract Operation

A function to update hotel client vendor contracts.

Input Parameters
name type description
contract hotelClientContract The contract to update
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
Return Value
type description
hotelClientContract HotelClientContract object with violations if did not update/create properly.

updateHotelChainClientContract Operation

A function to update hotel chain client vendor contracts.

Input Parameters
name type description
contract hotelChainClientContract The contract to update
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
Return Value
type description
hotelChainClientContract HotelChainClient object with violations if did not update/create properly.

removeContract Operation

Remove a contract from a client.

Input Parameters
name type description
contractId long The contract id of the client contract to remove.
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
comment string  

removeAirContract Operation

Remove a AirContract from a client.

Input Parameters
name type description
contractId long The contract id of the client contract to remove.
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
comment string  

removeCarContract Operation

Remove a CarContract from a client.

Input Parameters
name type description
contractId long The contract id of the client contract to remove.
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
comment string  

removeHotelContract Operation

Remove a HotelContract from a client.

Input Parameters
name type description
contractId long The contract id of the client contract to remove.
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
comment string  

removeHotelChainContract Operation

Remove a HotelChainContract from a client.

Input Parameters
name type description
contractId long The contract id of the client contract to remove.
createTicket boolean [true|false] if the contract should create a help desk ticket to update the GDS
comment string  

getMidofficeClientContract Operation

Get a contract between a vendor and an account for midoffice purposes.

Input Parameters
name type description
accountnumber string The account number of the account.
clientId long The Airportal ID. Account number is not necessary if this is available.
type string The type of contract. A = Air, H = Hotel, C = Car
vendor string The code of the vendor that holds the contract.
location string The code of the locaiton that holds the contract.
Return Value
type description
midofficeClientContract The current contract that is active for this account.

getContractTypes Operation

Get all available contract types.

Input Parameters
name type description
typeId long Optional. Add if you only want a particlar travel type. 1 = Air, 2 = Car, 3 = Hotel.
airlineId long Optional. Add if you only want types available for a particular airline.
Return Value
type description
list of contractType A list of available contract types for the given parameters.

expireClientContracts Operation

Expire any contracts that have an expiration date before the provided date.

Input Parameters
name type description
today dateTime The day to expire all contracts before.
Return Value
type description
statusResponse A response as to if the method completed successfully.

updateContractAirType Operation

Create or Update the Contract Air Type

Input Parameters
name type description
contractAirType contractAirType  
Return Value
type description
contractAirType