Events & Ticketing (data-pv-component="event")

data-pv-type=

eventList

displays a list of upcoming events based on the query of string and/or data-pv-parameters.

parameters possible values
date_from - string
  • 9/23/2019 9:49:16 AM
  • {@today:addDays(#)@}
  • {@today:addMonths(#)@}
  • {@today:addYears(#)@}
  • 9/1/2019 12:00 AM
  • 9/30/2019 11:59:59 PM
  • 10/1/2019 12:00 AM
  • 10/31/2019 11:59:59 PM
  • 8/1/2019 12:00 AM
  • 8/31/2019 11:59:59 PM
  • Standard day and time format
    1/1/1900 12:00 AM
date_to - string Same as date_from
event_keyword - string
search_for - string
event_id - string
returnTotal - integer The number of events you want to show
category_no - integer You can find this number by going to the target category's page and looking at the end of the url
event_location - string
not_category_nos - string

eventView

This will display the event details.

parameters possible values
event_no - string
reference_no - string

Content (data-pv-component="content")

data-pv-type=

snippet

This will display a content snippet in the specified HTML tag.

parameters possible values
marketing_keyword - string
page_status - string
lightweight - string
render - string

page

This brings back a single page.

parameters possible values
page_no - string
page_status - string
render - string
business_no - string

rotators

this will return the rotators for a specific group.

parameters possible values
activeOnly - string
rotator_group - string
rotator_type - string
rotator_title - string
sortBy - string
  • newest
  • posted_on
rotator_no - string
returnTotal - string

list

this will display a list of content pages based on parameters.

parameters
page_no - string
page_status - string
page_type - string
category_no - string
includeSubCategories - string
marketing_keyword - string
search_for - string
sortby - string
  • newest
  • posted_on
returnTotal - string
lightweight - boolean
render - boolean
business_no - boolean

faq

will return FAQ data.

parameters
search_for - string
category_no - string
rotator_type - string
rotator_title - string
sortBy - string
  • newest
  • posted_on
rotator_no - string
returnTotal - string

Contest (data-pv-component="contest")

leaderboard

This would display the current results of the contest including all contestants.

parameters
contest_no - string
customer_no - string
from_date - string
to_date - string
includeAll - string
rankTotal - string
rank_no - string

campaign (data-pv-component="campaign")

lists

This displays a list of items in a campaign that have been completed and the next one in play.

parameters
business_no - description
customer_no -
schedule_item_no -
category_no -
business_location_no -
return_total -
schedule_type -
visibility -
includeNextSlot -
canBook -
active -

posts

parameters
company_no -
search_value -
fund_campaign_no -
fund_campaign_post_no -
customer_no -
from_date -
to_date -
sort_by -

donations

parameters
company_no -
display_public -
fund_campaign_no -
fund_campaign_post_no -
customer_no -
transaction_no -
from_date -
to_date -
return_total -

Notes (data-pv-component="notes")

Notes

This displays a list of notes.

parameters
notes_no
note_type
note_details
note_status
created_on
first_name
last_name
user_no
followup_date

Scheduler (data-pv-component="scheduler")

item

This provides the full details on a scheduler.

parameters
"business_no"
"customer_no"
"schedule_item_no"
"category_no"
"business_location_no"
"return_total"
"schedule_type"
"visibility"
"includeNextSlot"
"canBook" - boolean true OR false

days

Provides a list of the available dates using start_date and slots_available

parameters
schedule_item_no -
return_total -
slot_start -
slot_end -

slots

Provides a list of available schedule slots.

parameters
company_no -
schedule_item_no -
return_total -
slot_start -
slot_end -

bookings

Returns all the bookings for a customer. Customer_no must be supplied.

parameters
customer_no
business_no
return_total
sort_by

booking

Return a single booking either by schedule_book_no, schedule_slot_no or schedule_item_no along with customer_no.

parameters
customer_no
schedule_book_no
schedule_slot_no
schedule_item_no

About (data-pv-component="about")

Directory (data-pv-component="directory")

business_locations

This lists out the business and business locations.

parameters
"user_latitude" description
"user_longitude"
"business_no"
"search_for"
"name_search"
"category_no"
"city"
"country"
"state"
"zip_code"
"business_type"
"includeBusiness"
"total_results"
"sort_by"

business

This will return a business or businesses matching criteria.

parameters
"location"
"latitude"
"longitude"
"business_type"
"business_no"
"returnAttributes"
"returnLocations"
"includeDetails"
"returnMedia"
"returnDataAttributes"
"returnTotal"
"customer_no"
"category_no"
"sort_by"
"business_status"

Media (data-pv-component="media")

media

This outputs all media based on the search.

parameters
media_type
reference_type
reference_no
media_no
returnTotal
sortby
  • newest
  • posted_on
search_for
reference_id

Company (data-pv-component="company")

company

This displays the company information inline

parameters

Survey (data-pv-component="survey")

info

Returns basic info about the survey.

parameters
totalResults
hideFields
user_no
isTemplate
survey_no
survey_no
search_for
reference_type
reference_no
publicOnly
sortby
  • newest
  • posted_on
business_no

applicationStats

Returns the stats for an application (survey/group).

parameters
survey_group_no

responses

Returns all the responses for a survey group, survey, customer or business.

parameters
survey_no
survey_group_no
customer_no customer.customer_no
from_date
to_date
business_no
returnTotal
response_status

response

Returns the responses someone added for a survey.

parameters
survey_no
survey_response_no
business_no

formresponses

Returns all responses for a survey and allows to filter by status.

parameters
survey_no
survey_response_no
business_no
customer_no
response_id
sortby
  • newest
  • posted_on
from_date
to_date
response_data

application_responses

Returns responses to an application.

parameters
survey_group_no
survey_application_no
application_number
response_id
application_status
business_no

surveyapplicationstats

?

parameters
survey_group_no
business_no

application

Returns survey application.

parameters
includeAssignments
survey_group_no
customer_no
survey_group_name
survey_group_status
business_no

questions

Writes out all the questions/form fields (use {@input@} for the input field).

parameters
survey_no
survey_field_no
search_for

Categories (data-pv-component="categories")

empty - allows you to search for categories

Return Gallery categories: component_no=-1.

parameters

Request (data-pv-component="request")

This allows you to call an external URL and convert the data to an object.

<enter URL>

Make sure you set data-pv-object="obj" to set the data to the javascript for processing.

parameters

Memberships (data-pv-component="membership")

list

Returns a list of membership types and filterable.

parameters
totalResults
membership_name
hideAssignedToLoyalty
category_no
service_no
sortby
  • newest
  • posted_on
onlyShowSelfSignup
membership_status

info

Returns 1 that matches the membership_no.

parameters
totalResults
membership_no

members

Returns a list of members.

parameters
returnTotal
search_for
sort_by

memberships

Brings back person's membership.

customer_nameonlyDirectoryEnabled
parameters
customer_no
membership_no
membership_id
membership_status
membership_sku
category_no
from_date
to_date
includeTotalRecords
page_number
rows_per_page

Text (data-pv-component="text")

This will just output the text or HTML that's in the object; it's used for conditional content..

parameters

Gift Cards (data-pv-component="giftcard")

Empty

This will output the gift card and messaging associated with it.

parameters

Stats

This will return a general stats about balance.

parameters
customer_no
status
customer_reference
return_total
gift_card_no
current_value
customer_no
serial_number
gift_card_pin
status
sort_by

Notifications (data-pv-component="notification")

on-page

This will return on page notifications based on setting.

parameters
hideVisibility
notification_title
notification_type
customer_no
notification_view
reference_type
reference_no
category_no
category_name
notification_key

Bookings (data-pv-component="bookings")

Returns all bookings of events and scheduler.

parameters
from_date
to_date
booking_type
return_total

Loyalty (data-pv-component="loyalty")

activities

Returns all activities they can perform.

parameters
returnTotal
rank_no
customer_no
membership_id
sortby
  • newest
  • posted_on
onlyCompleted

earned

Returns a point_earned activity.

parameters
point_activity_no
point_earned_no
customer_no
business_no
search_for
reference_type
reference_no
status
from_date
to_date
sort_by
returnTotal

balance

Returns point balance.

parameters
customer_no
customer_reference
membership_id
mobile_number

dashboard

Returns total points, points until next reward, next level, total visits, total rewards available.

parameters
customer_no
customer_reference
membership_id
mobile_number

Commerce (data-pv-component="commerce")

shop

searches products as if it were on the /shop page.

parameters
includePricing
includeAttributes
category_no
flag
business_no
search_for
sortby
  • newest
  • posted_on
category_order_no
high
low
availableToPurchase
includePhotos
returnTotal
isLoyalty
restrictView
includeTotalRecords
page_number
rows_per_page
product_no

stats

displays the category statistics.

parameters
company_no
category_no
from_date
to_date

orders

list all order data for person.

parameters
company_no
includePayments
includeLineItems
includePull
includeShipping
commerce_coupon_no
customer_no
order_no
external_order_no
status_completed
start_date
end_date
order_type
order_via
isPaid / notPaid
isVerified / notVerified
isPulled / notPulled
isShipped / notShipped
isCompleted / notCompleted
isFollowedUp / notFollowedUp
isReturned / notReturned
isModified / notModified
sortby
  • newest
  • posted_on

Attributes (data-pv-component="attribute")

shop

returns a point_earned activity.

parameters

stats

eturns point balance.

parameters

orders

returns all activities they can perform.

parameters

Customer (data-pv-component="customer")

Attributes

returns all attributes for a customer (good for data-pv-object).

parameters
company_no
customer.customer_no
attribute_type
customer_attribute_no

Profile

returns the standard customer fields. You can also get to customer attributes by adding anywhere in page.

parameters

bookings

parameters
company_no
customer.customer_no
from_date
to_date
booking_type
return_total

Transaction (data-pv-component="transaction")

parameters

Messaging (data-pv-component="messaging")

messages

returns all messages in list.

parameters
company_no
message_no
message_type
mesasge_from
message_to
search_for
message_direction
message_id
customer_no
from_date
to_date
sortBy
  • newest
  • posted_on

conversation

returns conversations.

parameters
company_no
from_date
to_date
recipient
message_type
message_status
search_for
returnTotal

Chat (data-pv-component="chat")

thread

returns a single thread.

parameters
company_no
customer_no
chat_thread_no
reference_no
reference_type

conversation

returns conversations.

parameters
company_no
customer_no
reference_no
reference_type
from_date
to_date"

favorite (data-component="favorite"

favorite

parameters
reference_type
reference_id
reference_no
favorite_name

offers (data-pv-component="offers")

lists

provides a list of offers based on criteria.

parameters
company_no
pass_no
business_no
totalResults
includeExpired
pass_keyword
pass_name
includeLocations
city
state
zip_code
country

filters

returns a list of available filters.

subscription (data-component="subscription")

subscription

parameters
customer_no
affiliate_no subscription_no
subscription_no
subscription_frequency
sortby
  • newest
  • posted_on
active

fundcampaign (data-pv-component="fundcampaign")

campaign

provides the campaign with last 5 posts and donations (can be random)

parameters
company_no
fund_campaign_no
viewing_customer_no
customer_no"
pass_code
campaign_reached
visibility
category_no
start_date
end_date
sort_by
hideInactive
return_total
search_value
flag

posts

returns posts by the publisher

parameters
search_value
fund_campaign
fund_campaign_post_no
customer_no
from_date
to_date
sort_by

donations

returns donations made on the campaign.

parameters
display_public
fund_campaign_no
fund_campaign_post_no
fund_campaign_log_above
customer_no
transaction_no
from_date
to_date
sort_by
return_total

Projects (data-pv-component="project")

lists

returns all objects.

parameters
visibility -
project_phase -
project_title -
sort_by -
project_no
balance_due
project_cost
customer_no
contact_no
project_contact_no
category_no
user_no
checkAccess
start_date
end_date

bids

returns all bids.

parameters
project_no
customer_no
bid_total
project_bid_no
bid_status
sort_by
start_date
end_date

deliverables

returns all deliverables for project.

parameters
project_no
project_deliverable_no
customer_no
contact_no
deliverable_status
sort_by
start_date
end_date