API Method /events/properties/list
Lists all properties on an event.
Arguments
- authentication
- This method controls access via optional user authentication.
- id string
- The ID of the event.
Example Request
Here's an example request URL:
http://api.evdb.com/rest/events/properties/list?app_key=...&id=E0-001-000213902-2
Output Parameters
Output from this function is an XML block with the following constructs:
- properties
- A list of properties associated with the event. Each property entry has the
following structure:
- idinteger
- The ID of this property (used when removing).
- namestring
- The name of this property.
- valuestring
- The value of this property.
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<event>
<id>E0-001-000500753-9</id>
<properties>
<property>
<id>123</id>
<name>Rating</name>
<value>5 stars</value>
</property>
...
</properties>
</event>
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 event with the specified identifier.
- Not authorized
- The specified user does not have authorization to view the specified event.