HplCrudProvider Service

Created with IntelliJ IDEA. User: kstauffe Date: 9/20/13 Time: 8:58 AM To change this template use File | Settings | File Templates.

Namespace
http://hpl.service.cbtweb.cbt.com/
WSDL
hpl.wsdl
Path
/HplCrudProviderService

getHplQueueById Operation

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

hasBeenQueued Operation

Checks if this client has ever had the given locator queued to HPL within the last year

Input Parameters
name type description
locator string record Locator
accountNumber string accountNumber
Return Value
type description
boolean true or false

getHplQueues Operation

Input Parameters
name type description
list searchList  
Return Value
type description
list of hplQueue  

getHplQueuesGrid Operation

Input Parameters
name type description
list searchList  
Return Value
type description
list of hplQueueGrid  

getHplQueuesCount Operation

Input Parameters
name type description
list searchList  
Return Value
type description
long  

logAction Operation

Convenience endpoint for creating a new log entry

Input Parameters
name type description
hplQueueId long  
action string  
message string  
error boolean  
Return Value
type description
hplLog  

getLogsForHplQueue Operation

Input Parameters
name type description
id long  
Return Value
type description
list of hplLog  

getHplSettingsForClient Operation

Returns the HplSettings for the given client. This will look up the client tree until it finds one. If settings do not exist, this will create and persist a new HplSettings for the client.

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

getHplSettingsForClientNonParent Operation

Returns the HplSettings for the given client. This does NOT look up the client tree. If settings do not exist, this will create and persist a new HplSettings for the client.

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

getClientForHplSettings Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
client  

getHplSettingsById Operation

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

saveHplSettings Operation

Input Parameters
name type description
hplSettings hplSettings  
Return Value
type description
hplSettings  

saveTemplate Operation

Input Parameters
name type description
settingsId long  
template userDefinedFieldTemplate  
Return Value
type description
userDefinedFieldTemplate  

getTemplateById Operation

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

deleteTemplate Operation

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

getTemplates Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
list of userDefinedFieldTemplate  

addEmail Operation

Input Parameters
name type description
settingsId long  
hplEmail hplEmail  
Return Value
type description
hplEmail  

deleteEmail Operation

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

getEmails Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
list of hplEmail  

addDocument Operation

Input Parameters
name type description
settingsId long  
document hplDocument  
filename string  
Return Value
type description
hplDocument  

deleteDocument Operation

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

getDocuments Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
list of hplDocument  

getFaxIdsForConfirmation Operation

Return Value
type description
list of long  

getFaxQueueForHplQueueId Operation

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

getMaskedCreditCard Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
maskedCreditCard  

deleteCreditCard Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
boolean  

getMaskedEncompassCredentials Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
maskedEncompassCredentials  

deleteEncompassCredentials Operation

Input Parameters
name type description
settingsId long  
Return Value
type description
boolean  

changeEncompassCredentialsPassword Operation

Input Parameters
name type description
id long  
password string  
Return Value
type description
boolean  

getCheckinsForDate Operation

Input Parameters
name type description
date dateTime  
Return Value
type description
list of hotelSegment  

getHplBillingAccounts Operation

Input Parameters
name type description
month int  
year int  
Return Value
type description
list of hplBillingAccount  

getHplBillingTransactions Operation

Input Parameters
name type description
clientIds string  
month int  
year int  
Return Value
type description
list of hplBillingTransaction  

getHplClients Operation

Return Value
type description
list of client  

getHplLiteClients Operation

Return Value
type description
list of client  

getHplStats Operation

Return Value
type description
hplStats  

getDailyFaxFailedCount Operation

Input Parameters
name type description
userId long  
Return Value
type description
list of wt0TaskCount  

getMyBookingsDailyFaxFailedCount Operation

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

getHplsForRequeue Operation

Get all HPLs that failed to send, so we can queue them back to the system.

Return Value
type description
list of long A list of HPL IDs that failed to send.

getPreviouslyRunSegmentsForHpl Operation

Get a list of hotel segments that were previously run through HPL for a specific record locator.

Input Parameters
name type description
recordLocator string The record locator that may have some segments that were run through HPL.
accountNumber string The account that the record locator was booked for.
Return Value
type description
list of hotelSegment A list of hotel segments that have already had HPLs run for them.