4.3 ww.dll API Reference : API descriptions : Functions with database access : getdwinfo
 
getdwinfo
 
Description
getdwinfo returns information about an In-House Cards card. The information comes from the siriussp_GetDebitwareApproval stored procedure combined with fields from the gst_pass and guests tables. This also returns Cashout balance information from the cashoutbal fields and available Bonus Cash from the availbonus fields.
 
Input fields
 
XML tag
Description
<pass_no>
The pass number of the pass associated with the In-House Cards for which information is being returned.
<swipe_no>
The swipe number for the In-House Cards card for which information is to be returned.
 
Return fields
 
Field
Description
invoice_no
Invoice number.
inv_bal
Invoice balance.
sp_bal
Total amount spent during the history of this In-House Cards card. (Calculated value from stored procedure.)
sp_bal_dy
Total amount spent for the current day for this In-House Cards card. (Calculated value from stored procedure.)
crlimit
Credit limit for this In-House Cards card.
splimit
Total spending limit for this In-House Cards card.
splimit_dy
Daily spending limit for this In-House Cards card.
pass_no
Number of pass associated with In-House Cards card.
Pin_no
Returns a PIN if the DebitWare card is configured to require a PIN for purchases
swipe_no
Swipe number.
start_date
Start date.
expires
Expiration date.
dw_active
Indication of whether In-House Cards card is active.
department
In-House Cards item department.
category
In-House Cards item category.
item
In-House Cards item.
voided_by
If voided, name of operator who performed void.
voided_for
If voided, reason for void.
guest_no
Guest number.
first_name
Guest first name.
last_name
Guest last name.
dw_ignrexp
Boolean indicating whether to ignore expiration dates on In-House Cards items and rentals.
 
Example
 
Example invocation:
<func>getdwinfo</func><swipe_no>6035241000000139</swipe_no>
 
Example return string:
OK :...
<rs:data>
<z:row invoice_no='5003001' inv_bal='-18.00' sp_bal='2.00'
sp_bal_dy='.00' crlimit='.00' splimit='.00' splimit_dy='.00'
approval='162439' pass_no='25003001' swipe_no='6035241000000139 '
start_date='2006-11-01T00:00:00' expires='2008-01-20T23:59:59'
dw_active='True' department='INHOUSECRD' category='GIFTCERTS '
item='GIFTCERT ' voided_by='' voided_for='' guest_no='4000001'
first_name='NANI' last_name='GORING'/>
</rs:data>
 
See also
 
None.