API Library

getDayEvents

This method retrieves the active events, regardless of security category, occurring on a specified day.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CROrgEventAPISROrgEventAPIGET, POSTServer.

Client API Syntax

https://secure2.convio.net/organization/site/CROrgEventAPI?method=getDayEvents &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 ] &day=value &month=value &year=value [ &include_private_events=value ] [ &interests=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SROrgEventAPI?method=getDayEvents & 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 ] & day =value & month =value & year =value [ & include_private_events =value ] [ & interests =value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

day

Required. Specifies the day to retrieve (e.g. 1-31).

Type xsd:nonNegativeInteger.

month

Required. Specifies the month to retrieve (e.g. 1-12).

Type xsd:nonNegativeInteger.

year

Required. Specifies the month to retrieve (e.g. 2009).

Type xsd:nonNegativeInteger.

include_private_events

Optional. Specifies whether private events will be included in the results

Type xsd:boolean.

interests

Optional. Specifies a comma-separated list of interest names or IDs by which to filter the results. Names and IDs can be mixed in the same list. Items in the list that are all digits are assumed to be IDs. IDs or names that do match available interests are ignored without error. Spaces between items are ignored; spaces within a name are preserved.

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

day

Required. Specifies the day to retrieve (e.g. 1-31).

Type xsd:nonNegativeInteger.

month

Required. Specifies the month to retrieve (e.g. 1-12).

Type xsd:nonNegativeInteger.

year

Required. Specifies the month to retrieve (e.g. 2009).

Type xsd:nonNegativeInteger.

include_private_events

Optional. Specifies whether private events will be included in the results

Type xsd:boolean.

interests

Optional. Specifies a comma-separated list of interest names or IDs by which to filter the results. Names and IDs can be mixed in the same list. Items in the list that are all digits are assumed to be IDs. IDs or names that do match available interests are ignored without error. Spaces between items are ignored; spaces within a name are preserved.

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getDayEventsResponse 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>2018-10-03-05:00</startDate>
      <endDate>2018-10-03-05:00</endDate>
      <startTime>11:01:10.379-05:00</startTime>
      <endTime>11:01:10.379-05: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>
</getDayEventsResponse>
JSON response
JSON
{"getDayEventsResponse":{"event":{"eventUrl":"http://www.event.org","eventLocation":{"stateProv":"State","zip":"ZIP","city":"City","street1":"Street1","street2":"Street2"},"name":"Event Name","description":"Event Description","id":"1000","eventType":"1","eventDate":{"endDate":"2018-10-03-05:00","startTime":"11:01:10.382-05:00","endTime":"11:01:10.382-05:00","startDate":"2018-10-03-05:00"}}}}