Thursday, October 16th, 2014 (updated 17 Oct ’14)

Documentation for eeMindBody v2.0

 

getClasses

Use the {exp:eemindbody:getclasses} tag to display information about classes on your site. This can be one class or an entire schedule.

Parameters

The limit=, orderby=, search:[fieldname]=, sort= and offset= parameters are not passed to the API but instead are performed afterwards locally on the fetched dataset. This is because the API itself doesn't do these things. Note that you therefore won't see their effects when using the show_xml="y" option.

EndDateTime=

This is a raw parameter accepted by the API. It must be in the following format: YYYY-MM-DDTHH:MM:SS, eg, 2014-10-12T09:30:00, but the API ignore times, considering the time to be 23:59:59 regardless.

This parameter overrides the stop_before= parameter.

If neither the EndDateTime= nor the stop_before= parameter is used, then the fallback value is 1 week from the start date.

limit=

Setting this parameter limits the number of items displayed by the plugin. It works similarly to EE's channel:entries limit= parameter.

offset=

Setting this parameter offsets the results, like shifting an array. It works similarly to EE's channel:entries offset= parameter.

orderby=

Use this parameter to sort by any field in the dataset, eg, ClassDescription.Name. Unlike in EE's channel:entries tag, the parameter currently does not accept more than one value.

search:[fieldname]=

Filter results by searching for values contained within various fields.

For multiple values within the tag, separate values with the "|" character; these are considered "OR" operators (ie, a result can match any of the values). The parameter can be used multiple times within the tag; the multiple instances are joined by "AND" operators (ie, a result must match all the values).

Unlike in the EE channel:entries search:[fieldname]= tag, there is currently no option for exact matching.

show_xml=

Use this parameter for debugging. See the Debugging docs page.

sort=

Use this in tandem with the orderby= parameter. Works the same way as in the EE channel:entries tag.

start_on=

Use the format YYYY-MM-DD. This parameter is overridden by the StartDateTime= parameter if it exists.

StartDateTime=

This is a raw parameter accepted by the API. It must be in the following format: YYYY-MM-DDTHH:MM:SS, eg, 2014-10-12T09:30:00, but the API ignore times, considering the time to be 00:00:00 regardless.

If neither the start_on= nor StartDateTime= parameter is used, the fallback day is the current day.

stop_before=

Use the format YYYY-MM-DD. This parameter is overridden by the EndDateTime= parameter if it exists.

Variables

Fieldnames

The SOAP response for the MindBody API's getClasses method is a hierarchical object, and the plugin flattens that but maintains the structure within the fieldnames, where a "." denotes the hierarchy.

Following is a list of all the fields available:

  • getClass
  • Location.SiteID
  • Location.BusinessDescription
  • Location.AdditionalImageURLs (array)
  • Location.FacilitySquareFeet
  • Location.TreatmentRooms
  • Location.HasClasses
  • Location.PhoneExtension
  • Location.ID1
  • Location.Name
  • Location.Address
  • Location.Address2
  • Location.Tax1
  • Location.Tax2
  • Location.Tax3
  • Location.Tax4
  • Location.Tax5
  • Location.Phone
  • Location.City
  • Location.StateProvCode
  • Location.PostalCode
  • Location.Latitude
  • Location.Longitude
  • Location.ImageURL
  • Location.Description
  • MaxCapacity
  • WebCapacity
  • TotalBooked
  • TotalBookedWaitlist
  • WebBooked
  • SemesterID
  • IsCanceled
  • Substitute
  • Active
  • IsWaitlistAvailable
  • IsEnrolled
  • HideCancel
  • ID
  • IsAvailable
  • StartDateTime
  • EndDateTime
  • ClassDescription.Level.ID
  • ClassDescription.Level.Name
  • ClassDescription.ID
  • ClassDescription.Level.Name
  • ClassDescription.Level.Description
  • ClassDescription.Level.Prereq
  • ClassDescription.Level.Notes
  • ClassDescription.Level.LastUpdated
  • ClassDescription.Level.Program
  • ClassDescription.Level.Program.ID
  • ClassDescription.Level.Program.Name
  • ClassDescription.Level.Program.ScheduleType
  • ClassDescription.Level.Program.CancelOffset
  • ClassDescription.Level.SessionType.DefaultTimeLength
  • ClassDescription.Level.SessionType.ProgramID
  • ClassDescription.Level.SessionType.NumDeducted
  • ClassDescription.Level.SessionType.ID
  • ClassDescription.Level.SessionType.Name
  • Staff.MobilePhone
  • Staff.Address
  • Staff.City
  • Staff.State
  • Staff.Country
  • Staff.PostalCode
  • Staff.ID
  • Staff.Name
  • Staff.FirstName
  • Staff.LastName
  • Staff.ImageURL
  • Staff.Bio
  • Staff.isMale

These are used within squiggly brackets,eg, {Location.Address} or {Staff.FirstName}.

Examples


<ul>
{exp:eemindbody:getclasses 
	start_on="2014-10-12"
	stop_before="2014-10-12"
	limit="10"
	sort="asc"
	show_xml="n"
}
<li>
	<b>{ClassDescription.Name}</b> ({ClassDescription.Program.Name})<br>
	<b>{Staff.FirstName} {Staff.LastName}</b><br>
	({StartDateTime} @ {Location.Address})
</li>
{/exp:eemindbody:getclasses}
</ul>

Post a comment

Name:

Email:

Location:

URL:

Your comment:

Remember my personal information
Notify me of follow-up comments?

Please enter the word you see in the image below: