AL-Desk Web Portal API 1.1.3.6m_ssl

Compact View

Category MethodName Params Type Notes
AL-Deskals_get_affiliates.cgi [Docs]affiliate[Integer]
agencyid[Integer]
Get 
AL-Deskals_get_affliates.commission.cgi [Docs] Get 
AL-Deskals_get_categories.cgi [Docs]category[Integer]
categorygroup[Integer]
categorysearch[String]
descriptionsearch[String]
imageurl[Boolean]
includedesc[Boolean]
location[Integer]
Get 
AL-Deskals_get_category_groups.cgi [Docs] Get 
AL-Deskals_get_client.cgi [Docs]ccinfocheck[String]
client[Integer]
email[String]
externalcode[String]
Get 
AL-Deskals_get_client_changes.cgi [Docs]client[Integer][Required]
Get 
AL-Deskals_get_locations.cgi [Docs]content[Boolean]
location[Integer]
showall[Boolean]
Get 
AL-Deskals_get_method_requests.cgi [Docs] Get 
AL-Deskals_get_product_changes.cgi [Docs]product[Integer][Required]
Get 
AL-Deskals_get_product_rates.cgi [Docs]product[Integer]
ratecode[Integer]
vendor[Integer]
Get 
AL-Deskals_get_properties.cgi [Docs] Get 
AL-Deskals_get_rates_additional.cgi [Docs]productrate[Integer]
Get 
AL-Deskals_get_tours.cgi [Docs]client[Integer]
date[Date][Required]
property[Integer]
voucher[Integer]
Get 
AL-Deskals_get_tour_types.cgi [Docs] Get 
AL-Deskals_get_transaction_types.cgi [Docs] Get 
AL-Deskals_get_vendors.cgi [Docs]category[Integer]
extendedinfo[Boolean]
inactive[Boolean]
location[Integer]
vendor[Integer]
Get 
AL-Deskals_get_vendor_changes.cgi [Docs]vendor[Integer][Required]
Get 
AL-Deskals_get_vouchers.cgi [Docs]client[Integer]
detail[Boolean]
externalclientcode[String]
externalcode[String]
issued[Boolean]
seq[Integer]
sort[String]
voucher[Integer]
webclient[Integer]
Get 
AL-Deskals_get_voucher_commissions.cgi [Docs]activitydate[Date]
agency[Integer]
issueddate[Date]
thrudate[Date][Required]
Get 
AL-Deskals_get_voucher_detail.cgi [Docs]client[Integer]
externalclientcode[String]
externalcode[String]
seq[Integer]
voucher[Integer]
webclient[Integer]
Get 
AL-Deskals_get_waves.cgi [Docs]date[Date][Required]
property[Integer]
Get 
AL-Deskals_insert_product.cgi [Docs]active[Boolean]
agentnotes[String]
bookonlyonblock[Boolean]
checkintime[Time]
description[String]
groupcode[Integer]
location[Integer][Required]
name[String][Required]
nopremium[Boolean]
prodcat[Integer][Required]
sequenceorder[Integer]
shortname[String]
taxrate[Float]
timevalue[Time]
trantype[Integer]
usespickup[Boolean]
useswebinterface[Boolean]
vendor[Integer][Required]
vouchernotes[String]
webexport[Boolean]
webjpglocation[String]
webusercode[Integer][Required]
Insert 
AL-Deskals_insert_product_pricing.cgi [Docs]active[Boolean]
commission[Currency]
commrate[Float]
effectivedate[Date]
effectivetourdate[Date]
fixedtax1[Currency]
fixedtax2[Currency]
fixedtax3[Currency]
fixedtaxcommstat1[Integer]
fixedtaxcommstat2[Integer]
fixedtaxcommstat3[Integer]
product[Integer][Required]
productrate[Integer][Required]
rate[Currency][Required]
vartax1[Currency]
vartax2[Currency]
vartax3[Currency]
vartaxcommstat1[Integer]
vartaxcommstat2[Integer]
vartaxcommstat3[Integer]
vartaxrate1[Float]
vartaxrate2[Float]
vartaxrate3[Float]
webusercode[Integer][Required]
Insert 
AL-Deskals_insert_product_rate.cgi [Docs]commrate[Currency]
name[String][Required]
product[Integer][Required]
rate[Currency]
seat[Boolean]
servicechargestate[Currency]
taxrate[Currency]
webusercode[Integer][Required]
Insert 
AL-Deskals_insert_tour.cgi [Docs]client[Integer][Required]
date[Date]
notes[String]
property[Integer]
qtyadult[Integer]
qtychild[Integer]
time[Time]
tourtype[Integer]
voucher[Integer][Required]
webusercode[Integer]
zip[String]
Insert 
AL-Deskals_insert_vendor.cgi [Docs]address1[String]
address2[String]
allowbookafterexpdate[Boolean]
city[String]
contact[String]
contractdate[Date]
contractnote[String]
description[String]
email[String]
excludefromap[Boolean]
fax[String]
imagepath[String]
insuranceexpirationdate[Date]
location[Integer][Required]
logopath[String]
name[String][Required]
newcommratedate[Date]
notes[String]
outofbusiness[Boolean]
phone[String]
phone2[String]
shortname[String]
showgiftdiscount[Boolean]
state[String]
taxoverride[Boolean]
taxrateoverride[Boolean]
tollnumber[String]
transtype[Integer]
webexport[Boolean]
webusercode[Integer][Required]
zip[String]
Insert 
AL-Deskals_insert_voucher_payment.cgi [Docs]address1[String]
address2[String]
agent[Integer]
amount[Currency][Required]
CCAmountTest[Boolean]
cccid[String]
ccExp[String]
ccname[String]
ccnumber[String]
CCTestApproval[Boolean]
CCTestOnly[Boolean]
city[String]
client[Integer][Required]
controlno[Integer]
merchant[Integer]
reference[String]
state[String]
timeout[Integer]
voucher[Integer]
voucher1[Integer]
voucher2[Integer]
voucher3[Integer]
voucher4[Integer]
voucher5[Integer]
voucher6[Integer]
voucher7[Integer]
voucher8[Integer]
webusercode[Integer][Required]
zip[String]
InsertCredit Card Parameters only valid via SSL channel
AL-Deskals_send_email_voucher.cgi [Docs]client[Integer][Required]
emailbcc[String]
emailto[String]
voucher[Integer][Required]
webusercode[Integer][Required]
Get 
AL-Deskals_update_product.cgi [Docs]active[Boolean]
agentnotes[String]
bookonlyonblock[Boolean]
checkintime[Time]
description[String]
groupcode[Integer]
location[Integer]
name[String]
nopremium[Boolean]
prodcat[Integer]
product[Integer][Required]
product[Integer]
sequenceorder[Integer]
shortname[String]
taxrate[Float]
timevalue[Time]
trantype[Integer]
usespickup[Boolean]
useswebinterface[Boolean]
vouchernotes[String]
webexport[Boolean]
webjpglocation[String]
webusercode[Integer][Required]
webusercode[Integer][Required]
Update 
AL-Deskals_update_product_rate.cgi [Docs]commrate[Currency]
name[String]
rate[Currency]
ratecode[Integer][Required]
seat[Boolean]
servicechargestate[Currency]
taxrate[Currency]
webusercode[Integer][Required]
Update 
AL-Deskals_update_vendor.cgi [Docs]address1[String]
address2[String]
allowbookafterexpdate[Boolean]
city[String]
contact[String]
contractdate[Date]
contractnote[String]
description[String]
email[String]
excludefromap[Boolean]
fax[String]
imagepath[String]
insuranceexpirationdate[Date]
location[Integer]
logopath[String]
name[String]
newcommratedate[Date]
notes[String]
outofbusiness[Boolean]
phone[String]
phone2[String]
shortname[String]
showgiftdiscount[Boolean]
state[String]
taxoverride[Boolean]
taxrateoverride[Boolean]
tollnumber[String]
transtype[Integer]
vendor[Integer][Required]
vendor[Integer]
webexport[Boolean]
webusercode[Integer][Required]
webusercode[Integer][Required]
zip[String]
Update 
Blocksals_get_block_adjustments.cgi [Docs]block[Integer]
Get 
Blocksals_get_block_availability.cgi [Docs]available[Integer]
blockno[Integer]
category[Integer]
enddate[Date][Required]
futuredays[Integer]
location[Integer]
product[Integer]
startdate[Date][Required]
time[Time]
used[Integer]
vendor[Integer]
vouchers[Boolean]
vouchersonly[Boolean]
Get 
Blocksals_get_block_defs.cgi [Docs]block[Integer]
enddate[Date]
product[Integer]
startdate[Date]
vendor[Integer]
Get 
Blocksals_get_block_voucher_detail.cgi [Docs]enddate[Date][Required]
startdate[Date][Required]
vendor[Integer]
Get 
Blocksals_get_current_blocks.cgi [Docs]block[Integer]
enddate[Date]
location[Integer]
product[Integer]
startdate[Date]
vendor[Integer]
Get 
Blocksals_insert_block_adjustment.cgi [Docs]block[String][Required]
date[Date][Required]
notes[String]
qty[Integer][Required]
time[Integer][Required]
webusercode[Integer][Required]
Insert 
Blocksals_insert_block_def.cgi [Docs]active[Boolean]
autoemail[Boolean]
autofax[Boolean]
blocktime[Time][Required]
email[String]
emailccto[String]
enddate[Date][Required]
faxno[String]
fri[Boolean]
mon[Boolean]
notes[String]
problock[Boolean]
product[Integer][Required]
quantity[Integer][Required]
releasedays[Integer]
releasetime[Time]
sat[Boolean]
sequenceorder[Integer]
startdate[Date][Required]
sun[Boolean]
thu[Boolean]
tue[Boolean]
webusercode[Integer][Required]
wed[Boolean]
Insert 
Blocksals_update_block_def.cgi [Docs]active[Boolean]
autoemail[Boolean]
autofax[Boolean]
block[Integer][Required]
blocktime[Time]
email[String]
emailccto[String]
enddate[Date]
faxno[String]
fri[Boolean]
mon[Boolean]
notes[String]
problock[Boolean]
product[Integer]
quantity[Integer]
releasedays[Integer]
releasetime[Time]
sat[Boolean]
sequenceorder[Integer]
startdate[Date]
sun[Boolean]
thu[Boolean]
tue[Boolean]
webusercode[Integer][Required]
wed[Boolean]
Update 
Companyals_get_company_info.cgi [Docs]content[Boolean]
Get 
Contentals_get_content.cgi [Docs]category[Integer]
data[Boolean]
name[String]
namespace[Boolean]
seq[Integer]
Get 
Contentals_get_content_categories.cgi [Docs]category[Integer]
content[Integer]
location[Integer]
name[String]
Get 
Contentals_get_content_locations.cgi [Docs]content[Integer]
location[Integer]
name[String]
Get 
Contentals_get_content_user_defined.cgi [Docs] Get 
Contentals_get_content_vendors.cgi [Docs]content[Integer]
name[String]
vendor[Integer]
Get 
Contentals_get_content_versions.cgi [Docs]active[Boolean]
category[Integer]
content[Integer]
name[String]
product[Integer]
seq[Integer]
Get 
Contentals_get_product_category_content.cgi [Docs]category[Integer]
location[Integer]
Get 
Contentals_insert_content_product.cgi [Docs]content[Integer][Required]
data[String]
description[String]
product[Integer][Required]
sortorder[Integer]
url[String]
VersionName[String]
webusercode[Integer][Required]
Insert 
Contentals_update_content_product.cgi [Docs]active[Integer]
data[String]
description[String]
seq[Integer][Required]
sortorder[Integer]
url[String]
VersionName[String]
webusercode[Integer][Required]
Update 
Contentals_update_product_category_content.cgi [Docs]category[Integer][Required]
content[Memo][Required]
location[Integer][Required]
url[String]
Update 
Credit Cardals_cc_update_guarantee.cgi [Docs]ccexpire[String]
ccguarantee[String]
client[Integer]
webclient[Integer]
Update 
Credit Cardals_credit_card_server_available.cgi [Docs] Get 
Credit Cardals_process_credit_card.cgi [Docs]address1[String]
address2[String]
amount[Currency][Required]
CCAmountTest[Boolean]
cccid[String][Required]
ccExp[String][Required]
ccname[String]
ccnumber[String][Required]
CCTestApproval[Boolean]
CCTestOnly[Boolean]
city[String]
client[Integer][Required]
controlno[Integer][Required]
guarantee[Boolean]
IsCredit[Boolean]
merchant[Integer]
state[String]
timeout[Integer]
webusercode[Integer][Required]
zip[String]
GetAvailable only via SSL channel
Emailals_get_email.cgi [Docs]webusercode[Integer][Required]
Get 
Emailals_send_email.cgi [Docs]body[String][Required]
emailbcc[String]
emailfrom[String]
emailto[String][Required]
subject[String][Required]
webusercode[Integer][Required]
Get 
Emailals_send_email_webclient_password.cgi [Docs]body[String]
content[String]
subject[String]
webclient[Integer][Required]
Get 
Faxals_fax_server_available.cgi [Docs] Get 
Faxals_send_fax.cgi [Docs]file[String]
html[String]
phone[String][Required]
url[String]
webusercode[Integer][Required]
Get 
Productsals_get_products.cgi [Docs]category[Integer]
categorygroup[Integer]
content[Boolean]
contentname[String]
descriptionsearch[String]
inactive[Boolean]
includedesc[Boolean]
location[Integer]
nodefaultcontent[Boolean]
product[Integer]
productsearch[String]
vendor[Integer]
Get 
Productsals_get_product_search.cgi [Docs]category[Integer]
categorygroup[Integer]
location[Integer]
search[String]
vendor[Integer]
Search 
Productsals_get_rates.cgi [Docs]activitydate[Date]
affiliate[Integer]
bookingdate[Date]
category[Integer]
content[Boolean]
date[Date]
discount[Boolean]
location[Integer]
mga[Boolean]
problocksonly[Boolean]
prodrate[Integer]
product[Integer]
productinfo[Boolean]
vendor[Integer]
webusercode[Integer]
wholesale[Boolean]
GetIdeal for Product page display when used with params:product,productinfo and content
Systemals_get_db_count.cgi [Docs] Get 
Systemals_get_methods.cgi [Docs] Get 
Systemals_get_method_params.cgi [Docs]method[Integer]
methodname[String]
Get 
Systemals_get_version.cgi [Docs] Get 
Voucherals_client_login.cgi [Docs]email[Integer][Required]
password[Integer][Required]
Get 
Voucherals_get_hotels.cgi [Docs]location[Integer]
Get 
Voucherals_insert_client.cgi [Docs]address1[String]
address2[String]
arrivaldate[Date]
ccexpire[String]
ccguarantee[String]
cellphone[String]
city[String]
departuredate[Date]
email[String]
externalcode[String]
faxphone[String]
firstname[String]
homephone[String]
hotel[Integer]
lastname[String]
notes[String]
otherphone[String]
password[String]
password[String]
room[String]
state[String]
webclient[Integer]
webusercode[Integer][Required]
workphone[String]
zip[String]
Insert 
Voucherals_insert_payment.cgi [Docs]amount[Currency][Required]
client[Integer][Required]
reference[String]
webusercode[Integer][Required]
Insert 
Voucherals_insert_voucher.cgi [Docs]activitydate[Date][Required]
activitytime[Time][Required]
address1[String]
address2[String]
agency[Integer]
agent[Integer]
block[Boolean]
CCAmountTest[Boolean]
cccid[String]
ccExp[String]
ccname[String]
ccnumber[String]
CCTestApproval[Boolean]
CCTestOnly[Boolean]
city[String]
client[Integer][Required]
controlno[Integer]
count[Integer][Required]
custompayment[Boolean]
externalcode[String]
merchant[Integer]
mga[Boolean]
notes[String]
pricingcode1[Integer]
pricingcode2[Integer]
pricingcode3[Integer]
pricingcode4[Integer]
pricingcode5[Integer]
pricingcode6[Integer]
pricingcode7[Integer]
pricingcode8[Integer]
problockonly[Boolean]
qty1[Integer]
qty2[Integer]
qty3[Integer]
qty4[Integer]
qty5[Integer]
qty6[Integer]
qty7[Integer]
qty8[Integer]
state[String]
timeout[Integer]
unissued[Boolean]
webusercode[Integer][Required]
zip[String]
InsertCredit Card Parameters only valid via SSL channel
Voucherals_update_client.cgi [Docs]address1[String]
address2[String]
arrivaldate[Date]
ccexpire[String]
ccguarantee[String]
cellphone[String]
city[String]
client[Integer][Required]
departuredate[Date]
email[String]
externalcode[String]
faxphone[String]
firstname[String]
homephone[String]
hotel[Integer]
lastname[String]
notes[String]
otherphone[String]
password[String]
room[String]
state[String]
webusercode[Integer][Required]
workphone[String]
zip[String]
Update 
Web Clientals_get_webclient.cgi [Docs]email[String]
password[String]
username[String]
vouchers[Boolean]
webclient[Integer]
Get 
Web Clientals_get_webclient_vouchers.cgi [Docs]detail[Boolean]
webclient[Integer][Required]
Get 
Web Clientals_insert_webclient.cgi [Docs]address1[String]
address2[String]
agency[Integer]
agencyid[Integer]
cellphone[String]
city[String]
country[String]
email[String]
fax[String]
firstname[String]
lastname[String]
notes[String]
password[String]
phone[String]
state[String]
username[String]
zip[String]
Insert 
Web Clientals_update_webclient.cgi [Docs]address1[String]
address2[String]
agency[Integer]
cellphone[String]
city[String]
country[String]
email[String]
fax[String]
firstname[String]
lastname[String]
notes[String]
password[String]
phone[String]
state[String]
username[String]
webclient[Integer][Required]
websession[String]
zip[String]
Update 
Web Clientals_webclient_attach.cgi [Docs]client[Integer][Required]
webclient[Integer][Required]
Get 
Web Clientals_webclient_remove.cgi [Docs]client[Integer][Required]
webclient[Integer][Required]
Get