API Method /calendars/search

This function handles calendar search. It performs the requested search, returning the results as an XML file. See the search box at http://eventful.com/calendars for an example interface.

Arguments

authentication: This method controls access via optional user authentication.
keywords string: The search keywords. (optional)

count_only boolean: If count_only is set, an abbreviated version of the output will be returned. Only total_items and search_time elements are included in the result. (optional)
sort_order string: One of 'relevance', 'date', 'title', 'venue_name', or 'distance'. Default is 'date'. (optional)
sort_direction string: One of 'ascending' or 'descending'. Default is 'ascending'. (optional)
page_size integer: The desired number of results per page. (optional)
page_number integer: The desired page number. (optional)

Example Request

Here's an example search URL:

http://api.evdb.com/rest/calendars/search?...&keywords=inging

Output Parameters

Output from this function is an XML block with the following constructs:

total_items integer

The total number of calendars matching this search. This can be an approximation if we wish.

page_size integer

The number of calendars per "page" returned.

page_count integer

The number of "pages" of output.

page_number integer

The current "page" number.

page_items integer

The number of calendars returned in this block. This is not necessarly the same as page_size. The last page, for instance, will probably not be a full page.

first_item integer

The item number of the first element on this page.

last_item integer

The item number of the last element on this page.

search_time float

The fractional number of seconds it took to satisfy this query.

calendars array

An array of page_items calendars. Each calendar entry has the following structure:

id string: The unique ID for this calendar.
calendar_name string: The calendar name.
description string: The calendar description.
owner string: The username of the calendar's owner.

Example XML Response

<?xml version="1.0" encoding="utf-8"?>
<search version="0.2">
  <total_items>1</total_items>
  <page_size>10</page_size>
  <page_count>1</page_count>
  <page_number>1</page_number>
  <page_items>1</page_items>
  <first_item>1</first_item>
  <last_item>1</last_item>
  <search_time>0.001</search_time>
  <calendars>
    <calendar id="C0-001-000002449-8">
      <calendar_name>inging in Boston</calendar_name>
      <description>This is the inging (pronounced "ing - ing") calendar for Boston...</description>
      <search_rank>1.0</search_rank>
      <event_count>11</event_count>
      <owner>dano</owner>
    </calendar>
  </calendars>
</search>

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: Either the 'keywords', 'location', or 'date' parameter is required.

Eventful

Overview

Tools