eventList

This will pull back all events set in the Control Panel and the data related to them.

The code snippet containing the HAPI outer block will be repeated for as many events set in the Control Panel (this can be set by the returnTotal parameter)

<div data-pv-component="event" data-pv-type="eventList" data-pv-object="abc">
    // Some code
</div>

Common HAPI elements used within the <div>:

  • {@category_name@} - this will return the category assigned to the Event (if one is assigned)

  • {@event_date@} - this will return the date/time of the event start time

  • {@event_date_end@} - this will return the date/time of the event end time

  • {@event_description@} - this will return the event description

  • {@event_graphic@} - this will return the url of the event graphic

  • {@event_title@} - this will return the event title

  • {@event_venue@} - this will return the event venue

Common data-pv-parameters used within the <div>:

  • category_no: '123'

  • includeCategories: true

  • returntotal: '999'

  • sortby: 'newest', 'oldest'

  • event_location: 'location'

Ticketed Events

For events that are ticketed, additional data values are available by adding parameters to HAPI call

<div data-pv-component="event" data-pv-type="eventList" data-pv-parameters="includeTickets:true" data-pv-object="abc">
    // Some code
</div>

HAPI elements

  • {@available_quantity@}

  • {@ticket_price@}

  • {@ticket_title@}

  • {@totalPurchased@}

Last updated