Method: /user
Retrieve information for a user.
Invocation
- This method can be invoked using either HTTP GET or HTTP POST.
- This method requires an API key
- This method can also be invoked using the alias user_by_id
Request Parameters
| Parameter | Description | Type | Extra |
| key | Zvents Developer API key | String | required |
| id | ID (or login) of the user | Integer or String | required |
Example Request
- http://www.zvents.com/rest/user?id=1&key=YOUR_API_KEY
Response Parameters
The response lists attributes of the requested user account.
| Parameter | Description | Type |
| id | The unique ID for the event. | Integer |
| login | The name of the user acount. | String |
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<rsp status="ok">
<stream_count>1</stream_count>
<user id="1">
<login>tyler</login>
</user>
</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 User ID: The user ID requested does not exist.
- Invalid API Key: The API key supplied is not valid.
- Call Limit Exceeded: The API key has exceeded the daily maximum number of calls.