F. Events
| Action | Method | URI |
|---|---|---|
| List Events | GET | /event |
| Get Event | GET | /event/member/{id} |
| Create Event | POST | /event |
| Update Event | PUT | /event/member/{id} |
| Update Event via client_id | PUT | /event |
| Delete Event | DELETE | /event/member/{id} |
| Delete Event via client_id | DELETE | /event |
| List Events on a User’s Schedule | GET | /event/rsvp |
| Add Event to a User’s Schedule | PUT | /event/rsvp/{id} |
| Add Event to a User’s Schedule via client_id | PUT | /event/rsvp |
Listing Events
These query parameters are available for listing Event objects (these do not apply to the user’s schedule resources).
| Parameter | Details | Default |
|---|---|---|
| event_page | Page number of records | 1 |
| limit | Number of records to return | 25 |
| terms | Optional, search terms |
Updating and Deleting via client_id
When updating or deleting events via a client_id, you must include the client_id that you created the event with:
http://example.zerista.com/event?client_id=1122334455&compan...
All fields included in an update request will be overridden to the given value. The response for updating a event is the same as creating an event.
Exhibitor Sessions
You may create a session that is specific to an exhibitor. These sessions will display on the exhibitor’s page only.
| Parameter | Example | Details |
|---|---|---|
| event[exhibitor_client_id] | aabbccddee | Optional, this is the client_id for an exhibitor.* |
* This parameter is only available when creating events.
Event Parameters
| Parameter | Example | Details |
|---|---|---|
| event[subject] | Keynote Address | Required |
| event[mceEditor] | <p>description</p> | Required, XHTML** |
| event[start] | 2009-03-24T13:30:00-06:00 | Required, XML dateTime* |
| event[finish] | 2009-03-24T14:45:00-06:00 | Required, XML dateTime* |
| client_id | 1122334455 | Optional*** |
* see http://www.w3.org/TR/xmlschema-2/#dateTime for information on the XML dateTime datatype. It is highly recommended that you include the appropriate timezone of the event.
** Event descriptions must be well-formed XHTML.
*** Providing the client_id is optional; however, you must track the event IDs, or you will not be able to update/delete the event without it.
Tags
Tags are a comma-separated list of words and phrases that are used when users search for events.
| Parameter | Example | Details |
|---|---|---|
| event[item_attributes][tags_list] | social networking, conferences, communities | Optional |
Location Parameters
| Parameter | Example | Details |
|---|---|---|
| location[name] | Zerista, Inc. | Optional* |
| location_address[street] | 3463 Blake St. | Optional** |
| location_address[street2] | Suite 200 | Optional** |
| location_address[city] | Denver | Optional** |
| location_address[state] | CO | Optional** |
| location_address[country_code] | US | Optional**, 2 character code*** |
* If you include an address, you must include location[name]
** Partial addresses are not allowed, you must include the full address.
*** see http://www.iso.org/iso/country_codes.htm
Exhibitor Sessions
You may create a session that is specific to an exhibitor. These sessions will display on the exhibitor’s page but not on the conference agenda.
| Parameter | Example | Details |
|---|---|---|
| event[exhibitor_client_id] | aabbccddee | Optional, this is the client_id for an exhibitor.* |
* This parameter is only available when creating events.
Speakers
You may add users as speakers to an event. You may add multiple speakers by augmenting the index like so:
event[speakers_attributes][0][user_client_id] event[speakers_attributes][1][user_client_id]
| Parameter | Example | Details |
|---|---|---|
| event[speakers_attributes][0][user_client_id] | aabbccddee | The client_id for a user. |
| event[speakers_attributes][0][type_name] | speaker | Optional. Values: ‘speaker’ (default), ‘moderator’, ‘author’, ‘presenter’, ‘submitter’, ‘chair’ |
Adding/Removing Events From Users’ Schedules via client_id
You can add or remove an event to a user’s schedule with the /event/rsvp URI. The request must include the event’s client_id, a user’s email address or client_id, and whether to add or remove the event.
| Parameter | Example | Details |
|---|---|---|
| user[email] | rufus@zerista.com | A user’s email address |
| user[client_id] | abcdefg | A user’s client_id |
| response | yes | ‘yes’ adds the event to the user’s schedule. ‘no’ removes the event from the user’s schedule. |
Adding/Removing Events From Users’ Schedules with Token Authentication Mimicking
You can add or remove an event to a user’s schedule with the /event/rsvp URI.
| Parameter | Example | Details |
|---|---|---|
| response | yes | ‘yes’ adds the event to the user’s schedule. ‘no’ removes the event from the user’s schedule. |
Atom Response Example
<?xml version="1.0" encoding="utf-8" ?>
<entry xmlns="http://www.w3.org/2005/Atom"
xmlns:atom="http://www.w3.org/2005/Atom">
<id>http://example.zerista.com/event/122</id>
<link rel="self" type="application/atom+xml"
href="http://example.zerista.com/event/122" />
<link rel="alternate" type="text/html"
href="http://example.zerista.com/event/122" />
<title>Keynote Address</title>
<updated>2009-07-28T11:10:54-06:00</updated>
<content type="application/xml">
<activity xmlns="http://ns.opensocial.org/2008/opensocial">
<id>http://example.zerista.com/event/122</id>
</activity>
</content>
</entry>
JSON Response Example
{
"id": 995105751,
"start": "2008-12-08T18:00:00Z",
"finish": "2008-12-08T20:20:00Z",
"status": "EVENT",
"track": {
"id": 267531883,
"position": 2,
"name": "Track 3 - Document Analysis"
},
"item": {
"id": 390,
"display_value": "T5P4OR2 Document Analysis and Recognition",
"created_on": {
"json_class": "Time",
"n": 273000000,
"s": 1227911471
},
"updated_on": {
"json_class": "Time",
"n": 273000000,
"s": 1227911471
},
"tags": [
],
"icon": {
"id": 11,
"content_type": "image/png",
"versions": {
"small_hover-32": "icon_11_32_hover.png",
"photo-640": "icon_11_640.png",
"extra_large-150": "icon_11_150.png",
"medium-64": "icon_11_64.png",
"small-32": "icon_11_32.png",
"logo-200": "icon_11_200.png",
"large-100": "icon_11_100.png"
}
},
"article": {
"id": 995105751,
"item_id": 390,
"content": "<p>11:00-11:20, Paper MoAT5.1</p> <p> Background Variability Modeling for Statistical Layout Analysis</p> <p> Shafait, Faisal German Res. Center for Artificial Intelligence (DFKI)</p> <p> van Beusekom, Joost Tech. Univ. of Kaiserslautern</p> <p> Keysers, Daniel German Res. Center for Artificial Intelligence (DFKI)</p> <p> Breuel, Thomas -</p> <p> </p> <p> 11:20-11:40, Paper MoAT5.2</p> <p> Script Identification of Camera-Based Images</p> <p> Li, Linlin Univ. of Singapore</p> <p> Tan, Chew-Lim National Univ. of Singapore</p> <p> </p> <p> 11:40-12:00, Paper MoAT5.3</p> <p> A Robust Front Page Detection Algorithm for Large Periodical Collections</p> <p> Konya, Iuliu Vasile Fraunhofer Inst. for IntelligentAnalysisandInformationSystems (IAIS)</p> <p> Seibert, Christoph Fraunhofer IAIS</p> <p> Glahn, Sebastian Fraunhofer-Inst. f\u00fcr Intelligente Analyse- und Informationssysteme IAIS</p> <p> Eickeler, Stefan Fraunhofer IAIS</p> <p> </p> <p> 12:00-12:20, Paper MoAT5.4</p> <p> Text Detection from Scene Images Using Sparse Representation</p> <p> Pan, Wumo CENPARMI, Concordia Univ.</p> <p> Bui, Tien D. Concordia Univ.</p> <p> Suen, Ching Y.</p>"
},
"phones": []
}
}
XML Response Example
<?xml version="1.0" encoding="UTF-8"?>
<event>
<id type="integer">995105751</id>
<start type="datetime">2008-12-08T18:00:00Z</start>
<finish type="datetime">2008-12-08T20:20:00Z</finish>
<event-status>EVENT</event-status>
<track>
<id type="integer">267531883</id>
<position type="integer">2</position>
<name>Track 3 - Document Analysis</name>
</track>
<item>
<id type="integer">390</id>
<display-value>T5P4OR2 Document Analysis and Recognition</display-value>
<created-on type="datetime">2008-11-28T22:31:11Z</created-on>
<updated-on type="datetime">2008-11-28T22:31:11Z</updated-on>
<tags type="array"/>
<icon>
<id type="integer">11</id>
<content-type>image/png</content-type>
<versions>
<small-hover-32>icon_11_32_hover.png</small-hover-32>
<photo-640>icon_11_640.png</photo-640>
<extra-large-150>icon_11_150.png</extra-large-150>
<medium-64>icon_11_64.png</medium-64>
<small-32>icon_11_32.png</small-32>
<logo-200>icon_11_200.png</logo-200>
<large-100>icon_11_100.png</large-100>
</versions>
</icon>
<article>
<id type="integer">995105751</id>
<item-id type="integer">390</item-id>
<content><p>11:00-11:20, Paper MoAT5.1</p> <p> Background Variability Modeling for Statistical Layout Analysis</p> <p> Shafait, Faisal German Res. Center for Artificial Intelligence (DFKI)</p> <p> van Beusekom, Joost Tech. Univ. of Kaiserslautern</p> <p> Keysers, Daniel German Res. Center for Artificial Intelligence (DFKI)</p> <p> Breuel, Thomas -</p> <p> </p> <p> 11:20-11:40, Paper MoAT5.2</p> <p> Script Identification of Camera-Based Images</p> <p> Li, Linlin Univ. of Singapore</p> <p> Tan, Chew-Lim National Univ. of Singapore</p> <p> </p> <p> 11:40-12:00, Paper MoAT5.3</p> <p> A Robust Front Page Detection Algorithm for Large Periodical Collections</p> <p> Konya, Iuliu Vasile Fraunhofer Inst. for IntelligentAnalysisandInformationSystems (IAIS)</p> <p> Seibert, Christoph Fraunhofer IAIS</p> <p> Glahn, Sebastian Fraunhofer-Inst. für Intelligente Analyse- und Informationssysteme IAIS</p> <p> Eickeler, Stefan Fraunhofer IAIS</p> <p> </p> <p> 12:00-12:20, Paper MoAT5.4</p> <p> Text Detection from Scene Images Using Sparse Representation</p> <p> Pan, Wumo CENPARMI, Concordia Univ.</p> <p> Bui, Tien D. Concordia Univ.</p> <p> Suen, Ching Y.</p></content>
</article>
<phones type="array"/>
</item>
</event>
Leave a Comment
