API Method /calendars/get

Given a calendar ID, returns the calendar data associated with that calendar.

Arguments

authentication: This method controls access via optional user authentication.
id string: The ID of the requested calendar.

Example Request

Here's an example request URL:

http://api.evdb.com/rest/calendars/get?...&id=C0-001-000002448-9

Output Parameters

Output from this function is an XML block ("calendar") with the following constructs.

id string

The unique ID for this calendar.

name string

The calendar name.

owner string

The username of the calendar's owner.

description string

The calendar description.

keywords string

The keywords associated with the calendar.

privacy integer

The calendar's privacy level: public ("1"), private ("2"), or sharable ("3").

notify_schedule string

Choice to notify owner on updates to calendar either "immediately", "daily", or "weekly".

what_query string

The keyword half of the query driving a smart calendar.

where_query string

The location half of the query driving a smart calendar.

properties

A list of properties for the event. Each property entry has the following structure:

idinteger: The ID of this property (used when removing).
namestring: The name of this property.
valuestring: The value of this property.

Example XML Response

<?xml version="1.0" encoding="UTF-8"?>

<calendar id="C0-001-000001163-4">
  <calendar_id>1163</calendar_id>
  <name>Mysterious Galaxy</name>
  <owner>chris_radcliff</owner>
  <description>Events taking place at the universe's best bookstore.</description>
  <keywords>bookstore "Mysterious Galaxy"</keywords>
  <privacy>3</privacy>
  <notify_schedule>immediately</notify_schedule>
  <what_query></what_query>
  <where_query>mysterious galaxy</where_query>
  <properties>
    <property>
      <id>123</id>
      <name>Rating</name>
      <value>5 stars</value>
    </property>
  </properties>
</calendar>

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: A required parameter was not provided.
Not found: There is no calendar with that identifier.
Read Access Denied: This Calendar is Marked Private.

Eventful API

Overview

Tools