API Method /performers/search

This function handles performer search. It performs the requested search, returning the results as an XML file. See the search box at http://eventful.com/performers for an example interface.

Arguments

authentication
This method controls access via authentication.
keywords string
The search keywords. (optional)
count_only boolean
If count_only is set, an abbreviated version of the output will be returned. Only total_items and search_time elements are included in the result. (optional)
sort_order string
One of 'relevance', 'name', 'event_count', 'demand_member_count', or 'created' (optional)
sort_direction string
One of 'ascending' or 'descending'. Default is 'ascending'. (optional)
page_size integer
The desired number of results per page. Maximum 100, defaults to 20. (optional)
page_number integer
The desired page number. (optional)

Example Request

Here's an example search URL:

http://api.eventful.com/rest/performers/search?...&keywords=wil+wheaton

Output Parameters

Output from this function is an XML block with the following constructs:
total_items integer
The total number of performers matching this search. This can be an approximation if we wish.
page_size integer
The number of performers per "page" returned.
page_count integer
The number of "pages" of output.
page_number integer
The current "page" number.
page_items integer
The number of performers returned in this block. This is not necessarly the same as page_size. The last page, for instance, will probably not be a full page.
first_item integer
The item number of the first element on this page.
last_item integer
The item number of the last element on this page.
search_time float
The fractional number of seconds it took to satisfy this query.
performers array
An array of page_items performers. Each performer entry has the following structure:
id string
The unique ID for this performer.
url string
The page URL for this performer on eventful.com.
name string
The name of this performer.
short_bio string
A short biography of this performer.
created datetime
The date & time the performer was initially created. (e.g. '2006-03-17 16:55:00')
creator string
The username of the performer's creator.
demand_count integer
The number of demands for this performer.
demand_member_count integer
The number of people who joined demands for this performer.
event_count integer
The number of events involving this performer.
image struct
An image entry

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>
<search version="0.2">
  <total_items>1</total_items>
  <page_size>10</page_size>
  <page_count>1</page_count>
  <page_number>1</page_number>
  <page_items>1</page_items>
  <first_item>1</first_item>
  <last_item>1</last_item>
  <search_time>0.003</search_time>
  <performers>
    <performer>
      <id>P0-001-000000567-9</id>
      <url>http://eventful.com/performers/wil-wheaton/author-blogger-actor-/
      P0-001-000000567-9?utm_source=apis&utm_medium=apim&utm_campaign=apic
      </url>
      <name>Wil Wheaton</name>
      <short_bio>writer, blogger, PokerStar, actor</short_bio>
      <created>2006-03-09 10:41:35</created>
      <creator>wilwheaton</creator>
      <demand_count>76</demand_count>
      <demand_member_count>635</demand_member_count>
      <event_count>0</event_count>
      <image>
        <caption/>
        <thumb>
          <url>http://images.evdb.com/images/thumb/I0-001/000/070/464-6.jpg</url>
          <width>48</width>
          <height>48</height>
        </thumb>
        <small>
          <url>http://images.evdb.com/images/small/I0-001/000/070/464-6.jpeg</url>
          <width>48</width>
          <height>58</height>
        </small>
        <medium>
          <url>http://images.evdb.com/images/medium/I0-001/000/070/464-6.jpeg</url>
          <width>128</width>
          <height>154</height>
        </medium>
      </image>
    </performer>
  </performers>
</search>

Error Codes

This method may return these errors in an error document:

Authentication error
The specified user was not found or provided invalid credentials.
Missing parameter
Either the 'keywords' or 'location' parameter is required.