Events

Action Method URI
List Events GET /event
Get Event GET /event/member/{id}
Create Event POST /event
Update Event PUT /event/member/{id}
Delete Event DELETE /event/member/{id}
Add Event To Schedule POST /event/rsvp/{id}
Remove Event From Schedule DELETE /event/rsvp/{id}
Manage a user’s schedule PUT /event/schedule

List Events

Parameter Details Default
event_page Page number of records 1
limit Number of records returned 50

Request

GET /event

View Sample Response

Top

Get Event

Parameter Details
id ID of the event

Request

GET /event/member/{id}

View Sample Response

Top

Create Event

You can create events via a POST request using the event parameters specified below. Upon successful completion of a POST request you will receive a 200 http response code. To update an existing event please see the Update Event section below.

Request

POST /event

Response

The response body will be the same format as the sample response below but for the newly created event instead of an array of events.
Top

Update Event

You can update an event via a PUT request using the event parameters specified below. All fields included in an update request will be updated to the given value. Upon successful completion of a PUT request you will receive a 200 http response code.
To specify the event to update please refer to Identifying Objects.

Request

PUT /event/member/{id}

Response

The response body will be the same format as the sample response below but for the updated event instead of an array of event.
Top

Delete Event

You can delete an event via a DELETE request. To specify the event to delete please refer to Identifying Objects.
Upon successful completion of a DELETE request you will receive a 200 http response code.

Request

DELETE /event/member/{id}

Top

Event Parameters

Parameter Example Details
event[item_attributes][display_value] Keynote Address Required
event[item_attributes][article][content] <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*
event[track_id] 1234 Optional (A track with that ID should be present in conference website)****
event[track_name] Keynote Optional (Provide either track ID or track name, but not both. If a track with the given name doesn’t exist a new track will be created)*****
event[max_attendees] 20 Optional
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.

**** An event’s track is unchanged if you do not pass the track_id parameter. If a blank value is provided for track_id the track will be disconnected from the event.

***** An event’s track is unchanged if you do not pass the track_name parameter. If a blank value is provided for track_name the track will be disconnected from the event.
Top

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

Top

Location Parameters

Parameter Example Details
location[item_attributes][display_value] 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[item_attributes][display_value]

** Partial addresses are not allowed, you must include the full address.

*** see http://www.iso.org/iso/country_codes.htm

**** An event’s location is unchanged if you do not pass the location parameters.
Top

Add 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’

* An event’s speakers are left unchanged if you do not pass speaker parameters.

Top

Exhibitor Sessions

You may create a session that is sponsored by an exhibitor. These sessions will display in the exhibitor’s profile and also in the main session listing.

Parameter Example Details
event[exhibitor_client_id] aabbccddee Optional, this is the client_id for an exhibitor.

Top

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 or Zerista ID. You can make a POST request to add an event and a DELETE request to remove an event from a user’s schedule.

Parameter Example Details
user[email] rufus@zerista.com A user’s email address
user[client_id] abcdefg A user’s client_id
user[id] 123456 A user’s ID in Zerista database
client_id 123456 An event’s client_id

Top

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.

Top

Manage a user’s schedule

You can manage a user’s schedule by doing a PUT /event/schedule request and passing the user’s client_id (or zerista id) and an array of client_ids of all the events that belong to the user’s schedule. This request will replace all the events in the user’s schedule with new set of events specified in the request.

Parameter Example Details
user[client_id] or user[id] 123456 A user’s client_id or A user’s ID in Zerista Database
event_client_ids[0] 123 You may add multiple events by augmenting the index.
event_client_ids[1] 456 You may add multiple events by augmenting the index.

Sample JSON Response for PUT /event/schedule requests

The response below is a JSON array of all the events currently in the user’s schedule. The field “id” represents the Zerista Id of the event and the field “client_ids” represents all the client_ids associated with that event.

[  
   {  
      "id":602369973,
      "client_ids":[  
         "defghi"
      ]
   },
   {  
      "id":1,
      "client_ids":[  
         "abcdef"
      ]
   }
]

Top

JSON Response Example

{
   "id":82020,
   "start":"2014-06-20T14:00:00Z",
   "finish":"2014-06-20T15:00:00Z",
   "parent_id":null,
   "track":{
      "id":2278,
      "position":1,
      "name":"Event Management",
      "color":"#45d0e6"
   },
   "name":"Certification in Exhibition Management (CEM) Intro",
   "updated_on":"2014-02-20T22:57:16.247918Z",
   "tags":[
      {
         "id":81145,
         "tag_name":"Event Consulting"
      },
      {
         "id":36825,
         "tag_name":"Event Marketing"
      }
   ],
   "content":"

The Certified in Exhibition Management (CEM) designation was created in 1975 to provide a professional designation for individuals in the exhibition industry. The designation was formed to raise professional standards and is recognized throughout the industry as the premier mark of professional achievement. The CEM Learning Program is a comprehensive course of study of specific and practical information within the exhibition and event management arena and is based on a Curriculum Blueprint that is composed of the essential concepts required of a competent professional in the area of Exhibition and Event Management. Because of the emphasis on practical knowledge, the CEM Learning Program is first, an education program, and second, a designation program. The CEM designation accommodates short- and long-term career goals with education that can be tailored to meet specific needs and interests. The CEM designation is obtained when a candidate completes a prescribed number of courses offered in classroom and on-line formats. The CEM Learning Program is a global designation offered in the United States, Canada, China, Korea, Mexico, Portugal, Singapore, Spain and Taiwan.

“, “icon_id”:382479, “client_ids”:[ ], “location”:{ “id”:866808, “name”:”Alameda” }, “speakers”:[ { “id”:”82020.369915″, “event_id”:82020, “user_id”:369915, “speaker_type”:”Speaker” } ], “survey_id”:159, “hashtags”:”” }

Top

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s