Method: /group_venues
Retrieve a list of venues that have been added to the group.
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 |
| key | Zvents Developer API key | String | required |
| id | ID of the group | Integer | required |
Example Request
- http://www.zvents.com/rest/group_venues?id=81&key=YOUR_API_KEY
Response Parameters
The response lists the venues that have been added to the group.
| Parameter | Description | Type | Mandatory |
| id | The unique ID for the venue. | Integer | Y |
| name | The name of the venue. | String | Y |
| description | A description of the venue. | String | |
| creator_id | The ID of the user that created the venue. | Integer | Y |
| link | The URL of the venue page on zvents.com | String | Y |
| url | The external URL of the venue. | String | |
| phone | The phone number of the venue | String | |
| address | The address of the venue | String | Y |
| city | The city of the venue | String | Y |
| state | The state of the venue | String | Y |
| country | The country of the venue | String | Y |
| zipcode | The zipcode of the venue | String | |
| timezone | The timezone of the venue | String | Y |
| latitude | The latitude of the venue | Float | Y |
| longitude | The longitude of the venue | Float | Y |
| hours | Hours of operation for the venue. | String | N |
| tags | A list of tags associated with this venue. | String List | |
| venue types | A list of types for this venue. | String List | |
| images | If this venue has images, this field provides a list of URLs for those images. | String List |
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<rsp status="ok">
<stream_count>2</stream_count>
<venue id="5813">
<name>Mission Bar</name>
<description></description>
<phone>(415) 647-2300</phone>
<link>http://www.zvents.com/venues/show/5813</link>
<url></url>
<creator_id>2</creator_id>
<address>2695 Mission St.</address>
<city>San Francisco</city>
<zipcode>94110</zipcode>
<state>California</state>
<country>United States</country>
<latitude>37.7539</latitude>
<longitude>-122.419</longitude>
</venue>
<venue id="5795">
<name>Bar 821</name>
<description></description>
<phone>(415) 596-3986</phone>
<link>http://www.zvents.com/venues/show/5795</link>
<url></url>
<creator_id>2</creator_id>
<address>821 Divisadero St.</address>
<city>San Francisco</city>
<zipcode>94117</zipcode>
<state>California</state>
<country>United States</country>
<latitude>37.777</latitude>
<longitude>-122.438</longitude>
</venue>
</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.
Possible Errors
This method may return one of the following errors.
- Unknown Group ID: The group ID requested does not exist.
- Insufficient Permissions: You are not allowed to see details for this group.
- Invalid API Key: The API key supplied is not valid.
- Call Limit Exceeded: The API key has exceeded the daily maximum number of calls.