API Method /users/get
Given a user ID, returns the user data associated with that user. See http://www.eventful.com/users/eventor for an example interface.
Arguments
- authentication
- This method controls access via authentication.
- id string
- The ID of the requested user.
- list-counts integer
- List counts of user activity. Set to 1 to display this data. (optional)
Example Request
Here's an example request URL:
http://api.eventful.com/rest/users/get?...&id=mruser
Output Parameters
Output from this function is an XML block with the following constructs.
- username string
- The user's username.
- bio string
- The user's description/bio.
- hometown string
- The user's hometown.
- first_name string
- The user's first name.
- last_name string
- The user's last name.
- interests string
- The user's interests.
- registration_date string
- The date and time the user was registered into Eventful. In the form of yyyy-MM-dd HH-mm-ss.nnnnnn (e.g. "2005-09-12 17:32:16.762752")
- reputation string
- The user's reputation. Default: 1. (Not fully implemented yet.)
- counts
- A list of counts of user activity
- demands integer
- Number of demands the user has joined.
- events integer
- Number of events the user has created.
- calendars integer
- Number of calendars the user has created.
- groups integer
- Number of groups that the user belongs to.
- events_going integer
- Number of events the user is planning to attend.
- venues integer
- Number of venues the user has created.
- venue_comments integer
- Number of venue comments the user has created.
- event_comments integer
- Number of event comments the user has created.
- demand_comments integer
- Number of demand comments the user has created.
- friends integer
- Number of friends of the user.
- family integer
- Number of family contacts.
- contacts integer
- Number of contacts the user has added.
- images
- A list of images associated with the user's buddy icon. Each image entry has the following structure:
- id integer
- Image id is the unique identifier for an image.
- url string
- The image URL.
- width integer
- The image width, in pixels.
- height integer
- The image height, in pixels.
- caption string
- The image caption. A short description of the image.
- links
- A list of links associated with the user. Each link entry has the
following structure:
- id integer
- This ID is the unique identifer for a link.
- url string
- The URL of this link.
- type string
- The link type id corresponding to a link type string as in the following list.
- description string
- The link description or name.
- create_time string
- Time the Link was added. In the form of yyyy-MM-dd HH-mm-ss.nnnnnn (e.g. "2005-09-12 17:32:16.762752").
- locales
- A list of locales that a user has associated with. See "Saved Locations" under user preferences.
- id integer
- The unique id of the locale.
- name string
- The text designation of the locale.
- modified string
- Timestamp this locale was last modified . In the form of yyyy-MM-dd HH-mm-ss.nnnnnn (e.g. "2005-09-12 17:32:16.762752") .
going
A list of events the user has marked as "going to." Each event entry has the
following structure:
- id integer
- The event id.
- title string
- The event title.
- start_time string
- The event start time, in ISO 8601 format (e.g. "2005-03-01 19:00:00").
- stop_time string
- The event stop time, if any, in ISO 8601 format (e.g. "2005-03-01 19:00:00").
- description string
- The event description.
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<user>
<username>mruser</username>
<bio>...</bio>
<hometown>San Diego, CA</hometown>
<first_name>Mr.</first_name>
<last_name>User</last_name>
<interests>...</interests>
<registration_date>2005-09-12 17:32:16.762752</registration_date>
<reputation>1</reputation>
<images>
<image id="890">
<url>http://images.evdb.com/images/small/m/mruser.jpg</url>
<width>48</width>
<height>48</height>
<caption></caption>
</image>
...
</images>
<links>
<link id="65">
<url>http://mruser.com</url>
<type>Website</type>
<description>http://mruser.com</description>
<create_time>2005-10-10 15:09:45.547389</create_time>
</link>
</links>
<locales>
<locale id="781">
<name>la jolla</name>
<modified>2005-09-21 16:18:13.341153</modified>
</locale>
...
</locales>
<going>
<event id="E0-001-000289059-4">
<title>ArtPower! @ UCSD: KRONOS QUARTET</title>
<start_time>2005-11-09 20:00:00</start_time>
<stop_time></stop_time>
<description>...</description>
</event>
...
</going>
</user>
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
- A required parameter was not provided.
- Not found
- There is no user with the specified identifier.
-