/getEvent
Updated
by
Jon Doehling
Get Event API Call
Retrieves an existing event in AES database and returns the event name with summations of current sales and payments.
Silent and Live auction sales are not included, as those may still be open for bidding and not yet finalized.
Pending credit card payments are not included, until they are actually processed and approved by the bank.
Only events where the organization matches the given API key will be returned.
Production Endpoint: https://auctionconductor.com/API/getEvent
QA Staging Endpoint: https://actestserver.com/API/getEvent
Accepted Data
Parameter | Req’d | Format | Default | Description |
event_id | Y | number | (none) | Unique AES identifier for the event. |
Return Values
Parameter | Value | Description |
event_id | number | Unique AES identifier for the event. |
name | text | Name of the event. |
total (sales) | number | Sum of all sales and current high bids for the event. NOTE: current high bids are included in totals, but are not final until the auction has closed. |
donations (sales) | number | Sum of all Donation package type sales for the event. |
regextra (sales) | number | Sum of all Registration Extras package type sales for the event. |
admissiontix (sales) | number | Sum of all Tickets and Admission package type sales for the event. |
multi-unit (sales) | number | Sum of all Multi-Unit package type sales for the event. |
sponsorship (sales) | number | Sum of all Sponsorship package type sales for the event. |
fixed_price (sales) | number | Sum of all Fixed Price package type sales for the event. |
silent_auction (sales) | number | Sum of all current high bids in the Silent Auction for the event. |
live_auction (sales) | number | Sum of all current high bids in the Live Auction for the event. |
total (payments) | number | Sum of all (authorized) credit card payments, plus cash and check payments. Note: Pending credit card transactions are not included in totals until submitted to the processor and approved. |
vs (payments) | number | Sum of all (authorized) Visa credit card payments |
ds (payments) | number | Sum of all (authorized) Discover credit card payments |
mc (payments) | number | Sum of all (authorized) Mastercard credit card payments |
amx (payments) | number | Sum of all (authorized) American Express credit card payments |
cash (payments) | number | Sum of all Cash payments |
check (payments) | number | Sum of all Check payments |
Sample Call
{
event_id: 2508
}Sample Response
{
"event_id": 2508,
"name": "Training Event"
"sales": {
"total": 45770.54,
"donations": 6372.54,
"regextra": 50,
"admissiontix": 8371,
"multi_unit": 1301,
"sponsorship": 3000,
"fixed_price": 100
"silent_auction": 26575,
"live_auction": 1
},
"payments": {
"total": 3318.76,
"vs": 0,
"ds": 0,
"mc": 0,
"amx": 1922.01,
"cash": 536.75,
"check": 860
}
}
