4.3 ww.dll API Reference : API descriptions : Functions with database access : getguest
 
getguest
 
Description
getguest retrieves a guest record, joined to the record(s) for the address(es).
 
Input fields
 
XML tag
Description
<guest_no>
Guest number.
<pass_no>
Optional. Pass number.
<gst_rent>
Optional. Automatically merge in the gst_rent information (use the alias r if you want to re-specify the fields to be retrieved other than the defaults). Boolean.
<fields>
<getphoto>
Optional. Boolean indicating whether getguest returns a photo.
 
Return fields
Recordset of all the fields in the guest, address and addlink tables with the exception of mug_shot. Mug shots, because they are graphics, tend to be large files. However, has_photo is returned with a value of 1 if the mug_shot field is populated (and 0 if not) and <getphoto>0<getphoto> can be used to retrieve a mug shot if needed.
 
Field
Description
guest_no
Guest number.
last_mod
Last modified.
salespoint
Salespoint.
operator
Operator.
date_time
Date/time.
parent_no
Parent number.
addit_no
Additional number.
addit_no2
Additional number 2.
trans_no
Transaction number.
guestgroup
Guest group.
salute
Salutation.
first_name
First name.
last_name
Last name.
e_mail
E-mail address.
birth_date
Birth date.
gender
Gender.
cc_swipe
Credit card swipe.
cc_number
Credit card number.
mug_date
Mug shot date.
notes
Notes.
e_message
E-message.
check_bx1
Check box 1.
check_bx2
Check box 2.
check_bx3
Check box 3.
check_bx4
Check box 4.
check_bx5
Check box 5.
check_bx6
Check box 6.
check_bx7
Check box 7.
check_bx8
Check box 8.
check_bx9
Check box 9.
check_bx10
Check box 10.
check_bx11
Check box 11.
check_bx12
Check box 12.
check_bx13
Check box 13.
check_bx14
Check box 14.
check_bx15
Check box 15.
number_1
Number 1.
number_2
Number 2.
number_3
Number 3.
number_4
Number 4.
number_5
Number 5.
text_1
Text 1.
text_2
Text 2.
text_3
Text 3.
text_4
Text 4.
text_5
Text 5.
text_6
Text 6.
text_7
Text 7.
text_8
Text 8.
memo_1
Memo 1.
memo_2
Memo 2.
memo_3
Memo 3.
date_1
Date 1.
datetime_1
Date/time 1.
gfwdstatus
Forward status.
guest_id
Guest ID.
relation
Relation.
role_no
Role number.
acct_name
Account name.
vipcode
VIP code.
height
Height.
weight
Weight.
height_m
Height in centimeters.
weight_m
Weight in centimeters.
no_mail
No mail.
no_email
No e-mail.
no_phone
No phone.
addlink_id
Add link ID.
address_id
Address ID.
addr_type
Address type.
address
Address.
address2
Address 2.
city
City.
state
State.
zip
Zip.
country
Country.
cntry_cod
Country code.
area_code
Area code.
phone
Phone.
cntry_cod2
Country code 2.
area_cod2
Area code 2.
phone2
Phone 2.
fax_ccode
Fax country code.
fax_acode
Fax area code.
fax_phone
Fax phone.
company
Company.
has_photo
Has photo.
address.phone_ext
Phone extension
address.phone2_ext
Secondary phone extension
address.fax_ext
Fax extension
card_on_file
Indicates the presence or absence of data in the guests.cc_swipe field by returning a 1 or 0 respectively.
 
Note: The address.fax_ext field is not returned with the lookupguests call because the address.fax_phone is not currently returned.
 
Note: The fields, address.phone_ext, address.phone2_ext and address.fax_ext are correctly updated if they are included in the modifyaddress call to ww.dll.
 
Note: The card_on_file field does not check the card number with a luhn check or check the expiration dates. It simply indicates that information is present.
 
Example
 
Example invocation:
<func>getguest</func><guest_no>26000001</guest_no>
 
Example return string:
OK :…recordset
<rs:data>
<z:row guest_no='26000001' last_mod='805' salespoint='OFFICE'
operator='ADMIN ' date_time='2007-10-18T09:54:36' parent_no='26000001'
addit_no='0' addit_no2='0' trans_no='0' guestgroup=''
salute='' first_name='BRAD ' last_name='HARRISON '
e_mail='bharrison@siriusware.com '
gender=' ' cc_swipe='' cc_number='' notes='' e_message=''
check_bx1='False' check_bx2='False' check_bx3='False'
check_bx4='False' check_bx5='False' check_bx6='False'
check_bx7='False' check_bx8='False' check_bx9='False'
check_bx10='False' check_bx11='False' check_bx12='False'
check_bx13='False' check_bx14='False' check_bx15='False'
number_1='0' number_2='0' number_3='0' number_4='.00'
number_5='.00' text_1='' text_2='' text_3='' text_4=''
text_5='' text_6='' text_7='' text_8='' memo_1='' memo_2=''
memo_3='' gfwdstatus='0' guest_id='0' relation='0' role_no='0'
acct_name='' vipcode='0' height='0' weight='0' height_m='0'
weight_m='0' no_mail='False' no_email='False' no_phone='False'
has_photo='0'/>
</rs:data>
</xml>
 
See also
lookupguests