Method: /group_delete
Delete a group.
Invocation
- This method must be invoked using 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/delete_group?id=81&key=YOUR_API_KEY
Response Parameters
The response lists the attributes of the deleted group.
| Parameter | Description | Type |
| id | The unique ID for the group (specified using an XML attribute). | Integer |
| name | The name of the group. | String |
| description | The description of the group. | String |
| url | The url of the group. | String |
| private | Specifies whether this group is private or public. Users cannot join private groups without an invitation. | Boolean |
| restrict_event_addition | Specifies whether this group restricts who can add events to the group calendar. Users cannot add events to restricted calendars. | Integer |
| creator_id | The ID of the user that created this group. | Integer |
Example Response
<rsp status="ok">
<stream_count>1</stream_count>
<group id="81">
<name>Featured Events</name>
<description>Events for the Zvents front page.</description>
<url>http://www.zvents.com</url>
<private>false</private>
<restrict_event_addition>1</restrict_event_addition>
<creator_id>1</creator_id>
</group>
</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 do not have permission to delete 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.