OfficeProvider Service

An API to interact with offices.

Namespace
http://inside.service.cbtweb.cbt.com/
WSDL
inside.wsdl
Path
/OfficeProviderService

getOfficeInfoById Operation

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

getOfficeInfoForClient Operation

Input Parameters
name type description
clientId long  
Return Value
type description
officeInfo  

getOfficeInfoFromPccAndBranch Operation

Get the office by the PCC and branch.

Input Parameters
name type description
pcc string The pcc to get the office for.
branch string The branch of the office.
gdsid long  
Return Value
type description
officeInfo The office retrieved from the pcc and branch.

removeOffice Operation

Remove an Office.

Input Parameters
name type description
office_id long The id of the office to remove.

updateOffice Operation

Update or save an office's information.

Input Parameters
name type description
office officeInfo The office to save or update.
Return Value
type description
officeInfo The office that was saved or has violations stating the failure.

searchOffices Operation

Build a query and search for offices based on the provided search list.

Input Parameters
name type description
searchList searchList The search list to build a query from.
Return Value
type description
list of officeInfo A list of offices.

countOffices Operation

Get the number of offices provided a given query.

Input Parameters
name type description
searchList searchList The query to count offices by.
Return Value
type description
long The number of offices provided the given query.

getClientsOfOfficeById Operation

Get all the Users from an office.

Input Parameters
name type description
id long The id of the office to find
Return Value
type description
list of client The list of clients retreived from the PCC.

getOverrideEmployeeForOffice Operation

Gets the employee that is responsible for all bookings in this office.

Input Parameters
name type description
officeId long The office id to get the overriding employee for.
Return Value
type description
employeeInfo The overriding employee for the office.

getEmployeeByUserAndOffice Operation

Get the employee that maps the given user to the given office.

Input Parameters
name type description
user_id long The user ID of the employee requested.
office_id long The office ID to get the employee for.
Return Value
type description
employeeInfo A EmployeeInfo object of the given user and office

setOverrideEmployeeForOffice Operation

Sets the employee that is responsible for all bookings in this office.

Input Parameters
name type description
officeId long The office id to set the overriding employee for.
employeeId long The employee that is responsible for all bookings in this office.

getOfficeBannerAds Operation

Get the banner ads for a particular office.

Input Parameters
name type description
officeId long The ID of the office to get the banner ads for.
Return Value
type description
list of officeBannerAd A list of banner ads for an office.

getOfficeBannerAdById Operation

Get a particular banner ad by id.

Input Parameters
name type description
bannerId long The ID of the banner ad.
Return Value
type description
officeBannerAd A banner ad with the given Id.

updateOfficeBannerAds Operation

Input Parameters
name type description
ad officeBannerAd  
Return Value
type description
officeBannerAd  

getApplicationLinksForOffice Operation

Get the links to display at the top of the application for a client of this office.

Input Parameters
name type description
id long  
Return Value
type description
list of officeAppLink The links to display at the top of the application for a client of this office.

getOfficeTravelPolicy Operation

Get the office's active travel policy.

Input Parameters
name type description
officeId long The id of the office.
Return Value
type description
officeTravelPolicy The active travel policy of the office.

getAllTravelPolicyActions Operation

get the list of possible actions a udid rule can perform.

Return Value
type description
list of clientTravelPolicyAction  

getOfficeTravelPolicyQueues Operation

Gets all of the queues for an office's travel policy.

Input Parameters
name type description
officeid long The id of the office.
Return Value
type description
list of travelPolicyQueue All queues related to this office's travel policy.

searchTravelPolicyQueues Operation

Search for travel policy queues.

Input Parameters
name type description
searchList searchList A query to find travel policy queues.
Return Value
type description
list of travelPolicyQueue A list of travel policy queues (typically used only for offices).

countTravelPolicyQueues Operation

Count travel policy queues.

Input Parameters
name type description
searchList searchList A query to count travel policy queues.
Return Value
type description
long A count of travel policy queues (typically used only for offices).

getAllAccountingSystems Operation

grabs a list of all different accounting systems

Return Value
type description
list of accountingSystem the list of all accounting systems.

updateOfficeTravelPolicy Operation

Update/create an office travel policy.

Input Parameters
name type description
policy officeTravelPolicy  
Return Value
type description
officeTravelPolicy the updated policy

updateTravelPolicyQueue Operation

update/create an office travel policy queue

Input Parameters
name type description
policyQueue travelPolicyQueue  
Return Value
type description
travelPolicyQueue  

deleteTravelPolicyQueue Operation

Removes a travel policy queue record.

Input Parameters
name type description
id long  

searchClientLocations Operation

get a list of all of the locations that match the search criteria.

Input Parameters
name type description
searchList searchList the criteria for the search.
Return Value
type description
list of clientLocation  

addUserToClientLocation Operation

adds a user to the client location

Input Parameters
name type description
userId long  
locationId long  
Return Value
type description
clientLocation  

removeUserFromClientLocation Operation

remove a user from the client location's users collection.

Input Parameters
name type description
userId long  
locationId long  
Return Value
type description
clientLocation  

getOfficeQueueSetup Operation

Get the default setup for this office's queues. This is really only applicable in GDSes that have categories (Apollo & Worldspan)

Input Parameters
name type description
officeid long The id of the office to get the default setup for.
Return Value
type description
list of queueTypeOfficeDefault A list of default queue categories for this office.

searchOfficeQueueDefaults Operation

Search for default queue setups per the office.

Input Parameters
name type description
searchList searchList The query to use to find queue setups.
Return Value
type description
list of queueTypeOfficeDefault A list of default queue setups.

countOfficeQueueDefaults Operation

Count the default queue setups per the office.

Input Parameters
name type description
searchList searchList The query to use to cound queue setups.
Return Value
type description
long A count of default queues setups.

updateQueueTypeOfficeDefault Operation

Update an office default.

Input Parameters
name type description
record queueTypeOfficeDefault The record to update.
Return Value
type description
queueTypeOfficeDefault The updated record. An ID means that it successfully saved.

deleteQueueTypeOfficeDefault Operation

Delete an office default for a queue category.

Input Parameters
name type description
id long The ID of the default record.

getMidofficeOfficeDetails Operation

Get all the information a midoffice should know for a travel agency site.

Input Parameters
name type description
pcc string The PCC representing the travel agency site.
branch string The branch representing a particular division inside the travel agency site.
Return Value
type description
midofficeOfficeDetail Details about a travel agency site, in reference to how tickets should be done.