4.3 ww.dll API Reference : API descriptions : Functions with database access : lookuppasses
 
lookuppasses
 
Description
lookuppasses looks up passes given a particular guest_no.
 
Input fields
 
XML tag
Description
<pass_no>
Pass number. Either a pass number, guest number, swipe number or additional number must be passed, at a minimum.
<guest_no>
Guest number. Either a pass number, guest number, swipe number or additional number must be passed, at a minimum.
<swipe_no>
Swipe number.
Example:
<func>lookuppasses</func><swipe_no>6035241234569040
</swipe_no>
Either a pass number, guest number, swipe number or additional number must be passed, at a minimum.
<addit_no>
Additional number. Usually refers to number printed on pass or ticket stock. Either a pass number, guest number, swipe number or additional number must be passed, at a minimum.
<date_time>
Optional. Date/time of interest.
<check_voids>
Optional. Can be passed (as 1) and voided passes are excluded. Boolean.
<fields>
Optional. Can be used to specify only certain fields to return using the aliases t for template and p for gst_pass. Note on the <fields> tag.
 
Return fields
Record set in XML format of gst_pass and template (all fields by default). If the date_time field is passed, then the start_time and expires fields are checked (to eliminate expired passes).
 
Note: Field names such as c60 that do not appear in the data dictionary are automatically generated when there are duplicate field names in joined data sets. These field names are not defined in the following table because their meanings vary. The description in the data set tells exactly what the duplicate field is.
 
Example:
<s:AttributeType name='c52' rs:name='department' rs:number='53' rs:nullable='true'
rs:writeunknown='true'>
<s:datatype dt:type='string' rs:dbtype='str' dt:maxLength='10'
                rs:fixedlength='true'/>
</s:AttributeType>
 
Field
Description
pass_no
Pass number.
guest_no
Guest number.
masterpass
Master pass.
swipe_no
Swipe number.
addit_no
Additional number.
val_parent
Validate parent record.
valprnttyp
Validate parent type.
last_use
Last use.
printcount
Number of times printed.
start_date
Start date.
expires
Expiration date.
validcount
Number of times validated.
dis_count
Like validcount, but can be reset.
total_uses
Total uses.
usesw_left
Uses left in current week.
week_refr
Used to determine when a week has passed.
usest_left
Uses left in current day.
day_refr
Used to determine when a day has passed.
points1
User-defined meaning.
points2
User-defined meaning.
money1
User-defined meaning.
money2
User-defined meaning.
blackout_s
Blackout start date.
blackout_e
Blackout end date.
warnings
User-defined meaning.
voided_for
Reason for void.
voided_by
Who voided.
shift_ends
Next time pass is validated.
trans_no
Transaction number.
mastertran
Master transaction.
department
Department.
category
Category.
item
Item.
amt_paid
Amount paid.
account
Account.
operator
Operator.
salespoint
Salespoint.
date_time
Date/time.
totalcomp
Total # of comps given to a guest who forgot his pass.
invoice_no
Invoice number.
cc_tracks
Hold some or all of the track1, 2 and 3 magnetic swipe info from card.
crlimit
Credit limit.
crlimit_dy
Credit limit per day.
dw_active
Indication of whether In-House Cards card is active.
splimit
Total spending limit for this In-House Cards card.
splimit_dy
Daily spending limit for this In-House Cards card.
last_mod
Last modified.
card_id
Card ID.
bl_reason
Blackout reason.
importpass
Import pass ID (for funding interface)
level_chg
Level change (for funding interface)
purch_chg
Purchase change to pass (for funding interface)
layout
Layout.
pref_prntr
Preferred printer.
one_access
Used internally by Sales.
t_wk_use
Uses allowed per week.
t_day_use
Uses allowed per day.
t_bl_out1s
Start of pass blackout period 1.
t_bl_out1e
End of pass blackout period 1.
t_bl_out2s
Start of pass blackout period 2.
t_bl_out2e
End of pass blackout period 2.
t_bl_out3s
Start of pass blackout period 3.
t_bl_out3e
End of pass blackout period 3.
t_bl_out4s
Start of pass blackout period 4.
t_bl_out4e
End of pass blackout period 4.
t_mon
Can pass be used on Mondays?
t_tue
Can pass be used on Tuesdays?
t_wed
Can pass be used on Wednesdays?
t_thu
Can pass be used on Thursdays?
t_fri
Can pass be used on Fridays?
t_sat
Can pass be used on Saturdays?
t_sun
Can pass be used on Sundays?
t_assignno
Get assignment number.
t_startime
Item is valid only between t_startime and t_endtime in a day.
t_endtime
Item is valid only between t_startime and t_endtime in a day.
t_ck_time
Enforce validation of the time portion of the start_date and expires fields?
t_asnotype
Assign number type.
t_newdnact
Create a new DirectNet account (in Sales) when this pass is created?
t_uvalue1
Are points1/money1 to be used for a unit value program?
t_uvalue2
Are points2/money2 to be used for a unit value program?
v_tot_use
What to do to total uses counter in pass when validated.
v_wk_use
What to do to uses per week counter in pass when validated.
v_day_use
What to do to uses per day counter in pass when validated.
v_points1
What to do to points1 counter in pass when validated.
v_points2
What to do to points2 counter in pass when validated.
v_money1
What to do to money1 counter in pass when validated.
v_money2
What to do to money2 counter in pass when validated.
v_delay
How much time should go by before the pass can be used again?
v_no_dscnt
Do not increment the discount counter when processing the validation.
a_autodep1
Department to use for automated sale in default time period.
a_autocat1
Category to use for automated sale in default time period.
a_autoitm1
Item to use for automated sale in default time period.
a_auto2
Time that second “auto” dept takes effect.
a_autodep2
Department to use for automated sale in second alternate time period.
a_autocat2
Category to use for automated sale in second alternate time period.
a_autoitm2
Item to use for automated sale in first second time period.
a_auto3
Time that third “auto” dept takes effect.
a_autodep3
Department to use for automated sale in third alternate time period.
a_autocat3
Category to use for automated sale in third alternate time period.
a_autoitm3
Item to use for automated sale in first third time period.
a_auto4
Time that fourth “auto” dept takes effect.
a_autodep4
Department to use for automated sale in fourth alternate time period.
a_autocat4
Category to use for automated sale in fourth alternate time period.
a_autoitm4
Item to use for automated sale in first fourth time period.
a_discnt1
When pass “discount” counter hits this level, use v_d1_flat and v_d1_pct to automatically discount auto sale item.
a_d1_flat
See a_discnt1.
a_d1_pct
See a_discnt1.
a_discnt2
When pass “discount” counter hits this level, use v_d2_flat and v_d2_pct to automatically discount auto sale item.
a_d2_flat
See a_discnt2.
a_d2_pct
See a_discnt2.
a_discnt3
When pass “discount” counter hits this level, use v_d3_flat and v_d3_pct to automatically discount auto sale item.
a_d3_flat
See a_discnt3.
a_d3_pct
See a_discnt3.
a_discnt4
When pass “discount” counter hits this level, use v_d4_flat and v_d4_pct to automatically discount auto sale item.
a_d4_flat
See a_discnt4.
a_d4_pct
See a_discnt4.
a_discnt5
When pass “discount” counter hits this level, use v_d5_flat and v_d5_pct to automatically discount auto sale item.
a_d5_flat
See a_discnt5.
a_d5_pct
See a_discnt5.
a_resetcnt
Reset discount counter in pass record to 0 after hitting discount level.
a_resetamt
Can be used to subtract a certain number from discount count instead of setting it to 0.
a_shiftype
Validation shift type.
a_sh_tot
If not first used in shift, change total uses counter in pass?
a_sh_wk
If not first used in shift, change total uses counter in pass?
a_sh_day
If not first used in shift, change uses per day counter in pass?
a_sh_pts1
If not first used in shift, change points1 counter in pass?
a_sh_pts2
If not first used in shift, change points2 counter in pass?
a_sh_mny1
If not first used in shift, change money1 counter in pass?
a_sh_mny2
If not first used in shift, change money2 counter in pass?
a_sh_disc
If not first used in shift, change discount in pass?
a_sh_tran
If not first used in shift, do automated sale?
a_sh_log
If not first used in shift, generate use_log record?
a_flexdate
Flexible date.
a_no_loc_s
Start of range for locations not accessible by this type of pass.
a_no_loc_e
End of range for locations not accessible by this type of pass.
a_no_loc_l
Comma delimited list of locations not accessible by this type of pass.
a_timespan
Used to calculate expires field if flex scanning is used to set start_date and expires upon first scan.
a_autofinl
When doing an auto-validation at a point-of-sale, should the auto-sale finalize itself or wait for user input.
cc_pid
Used to create valid credit/debit card numbers (DirectNet).
levelofval
Level of validation to be performed
do_on_val
String of SalesEZ application commands that can be run at the salespoint on validation.
dw
Is Debitware allowed for this pass?
dw_crl
Debitware default amount of credit limit.
dw_crlf
Debitware credit limit cannot be modified at salespoint when activated.
dw_spl
Debitware total spending limit.
dw_splf
Debitware spending limit cannot be modified at salespoint when activated.
dw_spld
Debitware daily spending limit.
dw_spldf
Debitware daily spending limit cannot be modified at salespoint when activated.
dw_acc
Debitware name of account where invoice is to be created.
dw_prel
Debitware amount that automatically gets put onto the Debitware invoice.
dw_ignrexp
Ignore expiration dates on Debitware cards.
log_chkpt
When validating, create a log entry in gst_ckpt table as well.
trklnoauto
Do not autosale if pass is invalid when trickle validating.
resortchrg
Is this pass product a Resort Charge capable product?
prescedenc
When validating passes, pass types can be ranked to determine which to validate first.
 
Examples
 
Example invocation:
<func>lookuppasses</func><guest_no>26000001</guest_no><check_voids>1</check_voids>
 
Example return string:
OK :…recordset
<rs:data>
<z:row pass_no='5000001' guest_no='26000001' masterpass='0'
swipe_no='' addit_no='0' val_parent='False' valprnttyp='1'
printcount='0' start_date='2006-11-01T00:00:00' expires='2008-04-
30T00:00:00'
validcount='0' dis_count='0' total_uses='0' usesw_left='0'
usest_left='0' points1='2' points2='0' money1='0' money2='0'
warnings='0' voided_for='' voided_by='' trans_no='0' mastertran='0'
department='PASSES' category='EMPLOYEE' item='EMPLOYEE'
amt_paid='399.95' account='' operator='WEBOP1' salespoint='WEBSP '
date_time='2007-10-18T10:57:31' totalcomp='0' invoice_no='0'
cc_tracks='' crlimit='0' crlimit_dy='0' dw_active='False'
splimit='0' splimit_dy='0' last_mod='75' card_id='0' bl_reason=' '
importpass='SPAS5000001' level_chg='0' purch_chg='0' c52='PASSES '
c53='EMPLOYEE ' c54='EMPLOYEE ' layout='CURRENTPASSEMP.FRX '
pref_prntr='' c57='False' c58='1' one_access='False' c60='2006-11-
01T00:00:00'
c61='2008-04-30T00:00:00' c62='0' c63='3' c64='4' c65='0'
c66='0' c67='0' t_wk_use='0' t_day_use='0' t_mon='True'
t_tue='True' t_wed='True' t_thu='True' t_fri='True' t_sat='True'
t_sun='True' t_assignno='True' t_startime=' ' t_endtime=' '
t_ck_time='False' t_asnotype='0' t_newdnact='False' t_uvalue1='False'
t_uvalue2='False' v_tot_use='-1' v_wk_use='0' v_day_use='0'
v_points1='0' v_points2='0' v_money1='0' v_money2='0'
v_delay='0' v_no_dscnt='False' a_autodep1=' '
a_autocat1=' ' a_autoitm1=' ' a_auto2=' '
a_autodep2='' a_autocat2=' ' a_autoitm2=' '
a_auto3=' ' a_autodep3='' a_autocat3=' '
a_autoitm3=' ' a_auto4=' ' a_autodep4=''
a_autocat4=' ' a_autoitm4=' ' a_discnt1='0'
a_d1_flat='0' a_d1_pct='.00' a_discnt2='0' a_d2_flat='0'
a_d2_pct='.00' a_discnt3='0' a_d3_flat='0' a_d3_pct='.00'
a_discnt4='0' a_d4_flat='0' a_d4_pct='.00' a_discnt5='0'
a_d5_flat='0' a_d5_pct='.00' a_resetcnt='1' a_resetamt='0'
a_shiftype='1' a_sh_tot='False' a_sh_wk='False' a_sh_day='False'
a_sh_pts1='False' a_sh_pts2='False' a_sh_mny1='False'
a_sh_mny2='False' a_sh_disc='False' a_sh_tran='False'
a_sh_log='True' a_flexdate='False' a_no_loc_s='0' a_no_loc_e='0'
a_no_loc_l='' a_timespan='0' a_autofinl='False' cc_pid=' '
levelofval='8' do_on_val='IGNOREERRORS()SELECTIVESPECIAL(&#x22;EMPRETAIL
&#x22;)IGNOREERRORS()SELECTIVESPECIAL(&#x22;EMPFOOD &#x22;)'
dw='True' dw_crl='0' dw_crlf='True' dw_spl='0' dw_splf='True'
dw_spld='0' dw_spldf='True' dw_acc='D-EMPPURCH' dw_prel='0'
dw_ignrexp='False' log_chkpt='False' trklnoauto='False'
c166='451' resortchrg='False' prescedenc='63'/>
</rs:data>