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

Documentation for eeMindBody v2.0

 

getClients

Use the {exp:eemindbody:getclients} tag to display information on your site about one or many clients.

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.

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, LastName. 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.

client_id=

Separate multiple MindBody IDs with the "|" character.

Unlike search:[fieldname]=, which is performed on the dataset after retrieval, this parameter is sent to and recognized by the MindBody API (as "ClientIDs"), so using show_xml="y" will show the results as filtered by this parameter.

Variables

  • Notes
  • AppointmentGenderPreference
  • Gender
  • IsCompany
  • LiabilityRelease
  • ID
  • FirstName
  • LastName
  • EmailOptIn
  • AddressLine1
  • City
  • PostalCode
  • Country
  • HomePhone
  • BirthDate
  • FirstAppointmentDate
  • HomeLocation
  • HomeLocation.SiteID
  • HomeLocation.BusinessDescription
  • HomeLocation.AdditionalImageURLs
  • HomeLocation.FacilitySquareFeet
  • HomeLocation.TreatmentRooms
  • HomeLocation.HasClasses
  • HomeLocation.PhoneExtension
  • HomeLocation.ID
  • HomeLocation.Name
  • HomeLocation.ImageURL
  • Description

Example


<ul>
{exp:eemindbody:getclients
	show_xml="y"
	client_id="188|100001084|7037197|7023164"
}
	<li>
		<b>{FirstName} {LastName}</b>
	</li>
{/exp:eemindbody:getclients}
</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: