Luminate Online

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CROrgEventAPI	SROrgEventAPI	GET, POST	Server.

Client API Syntax

https://secure2.convio.net/organization/site/CROrgEventAPI?method=getEvent &api_key=value &v=value [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &event_id=value

Server API Syntax

https://secure2.convio.net/organization/site/SROrgEventAPI?method=getEvent & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & event_id =value

Usage Notes

Information returned from the method includes:

eventType - This value corresponds to the Event Type selected when the Event was created.

0 = Standard Event
1 = Recurring Event
2 = Multi-day Event
3 = Multi-part Event

attendanceOption - This value is for standard and multiple day events, and corresponds to the Attendance Option selected when the Event was created.

0 = Open
1 = RSVP
2 = Ticket

Note: Recurring and multiple part events do not have the Attendance Option, so the value returned is 0 (Open attendance).

Client API Parameters

Common Client Parameters

See topic Common Parameters.

event_id

Required. Specifies the ID of the event to retrieve.

Type xsd:nonNegativeInteger.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

event_id

Required. Specifies the ID of the event to retrieve.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<getEventResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <event>
    <name>Event Name</name>
    <id>1000</id>
    <description>Event Description</description>
    <eventDate>
      <startDate>2016-02-01-06:00</startDate>
      <endDate>2016-02-01-06:00</endDate>
      <startTime>09:43:46.000-06:00</startTime>
      <endTime>09:43:46.000-06:00</endTime>
    </eventDate>
    <eventUrl>http://www.event.org</eventUrl>
    <eventType>1</eventType>
    <eventLocation>
      <city>City</city>
      <street1>Street1</street1>
      <stateProv>State</stateProv>
      <zip>ZIP</zip>
      <street2>Street2</street2>
    </eventLocation>
  </event>
</getEventResponse>

JSON response

{"getEventResponse":{"event":{"id":"1000","eventLocation":{"street2":"Street2","stateProv":"State","zip":"ZIP","street1":"Street1","city":"City"},"eventDate":{"startTime":"09:43:46.001-06:00","startDate":"2016-02-01-06:00","endDate":"2016-02-01-06:00","endTime":"09:43:46.001-06:00"},"description":"Event Description","name":"Event Name","eventUrl":"http://www.event.org","eventType":"1"}}}

getEvent