Zvents: API Documentation: /search_for_performers

Method: /search_for_performers

Search for performers.

Invocation

This method can be invoked using either HTTP GET or HTTP POST.
This method requires an API key

Request Parameters

Parameter	Description	Type	Extra
what	The string against which performers are matched. (e.g., madonna)	String	optional
limit	The maximum number of matching performers to return. The default is 10 and maximum is 10. Zvents partners can exceed the maximum.	Integer	optional
offset	The number of performers to skip from the beginning of the search results. If a search matches 1000 performers, returning 25 performers starting at offset 100 will return performers numbers 100-125 that match the search..	Integer	optional
cat	Restrict your search to items that belong to a specific category. You must provide a valid category identifier which can be determined using the performer categories API call.	Integer	optional

Example Request

http://www.zvents.com/rest/search_for_performers?what=katy+perry&limit=10&key=YOUR_API_KEY

Response Parameters

The response lists venues matching the search terms.

Parameter	Description	Type
id	The unique ID for the performer (specified using an XML attribute).	Integer
name	The name of the performer.	String
description	The description of the performer.	String
link	The URL for this event on www.zvents.com	String
url	The url of the performer.	String
creator_id	The ID of the user that created this performer.	Integer

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<rsp status="ok">
  <stream_count>2</stream_count>
  <performer id="81">
    <name>Madonna</name>
    <description>After a star reaches a certain point, it's easy to forget what they became famous for and concentrate solely on their persona. Madonna is such a star.</description>
    <url>http://www.madonna.com</url>
    <creator_id>1</creator_id>
  </performer>
  <performer id="267">
    <name>Katy Perry</name>
    <description>Katy Perry's mix of sass and spunk combines the cheeky, club-ready pop music of Lily Allen with the commercial pop/rock of Avril Lavigne and Alanis Morissette.</description>
    <url>http://www.katyperry.com/</url>
    <creator_id>47</creator_id>
  </performer>
</rsp>

Output Fields

Note: The REST API does not return all possible fields for each item by default. Since some response fields are not used by most API users, these fields are suppressed from the response by default in order to reduce latency for the common calls. Additional fields can be enabled in the response using the fields parameters documented in the 'Optimizing API calls for performance' section.

Output Formats

REST responses can be returned in a number of different formats include XML, JSON and CSV. Read the documentation on output formats.

Performance Considerations

For performance reasons, newly created items (events, venues, etc.) will not appear in search results from the REST API for up to an hour after the item was created. It is possible to eliminate this delay when using a commercial API key. Contact support for details.

Possible Errors

This method may return one of the following errors.

Invalid API Key: The API key supplied is not valid.
Call Limit Exceeded: The API key has exceeded the daily maximum number of calls.

Read the documentation on error formats.