Usage Notes
Make a GET request with your query appended as follows:
http://www.naturalinputs.com/query?k=API_KEY&t=CURRENT_TIME&q=lunch+tomorrow+at+noon
The current time parameter should be in the following format: yyyyMMddThhmmss
For example, November 5, 2008 at 2pm would look like this: 20081105T140000
Instructions for making request (Ruby)
Returned XML
a guess at the message intended by the user
- possible values: single, daily, weekly, daymonthly, datemonthly (examples below)
- the first occurrence, in "yyyymmdd" format
- the last occurrence, in "yyyymmdd" format
- start time on 24hr clock
- end time on 24hr clock
- interval of recurrence, for example "every other day" will have an interval of 2 (N/A for single date)
- day of the week for weekly and daymonthly recurrences
- daymonthly recurrences only, indicates week number. Possible values are 1,2,3,4,-1; -1 indicates the last week of the month
- datemonthly recurrences only. Possible values are 1 through 31
Occurrence type
Occurrence type has possible values of: single, daily, weekly, daymonthly, datemonthly.
Some examples of each should suffice:
- single -- "lunch with megan tomorrow at noon"
- daily -- "Art exhibit until March 1st"
- weekly -- "math class every wed from 8-11am"
- daymonthly -- "open bar at joes the first friday of every month"
- datemonthly -- "pay credit card bill on the 22nd of each month"
Occurrence interval
Supported interval values are 1, 2, and 3.
- Most cases will have an interval of 1, for example: "every wednesday", "the 21st of every month", or "every day".
- An interval of 2 would be something like: "every other friday", "the first tuesday of every other month", or "every other day"
- An inteval of 3 would be something like: "every three weeks starting this friday"
The easiest way to understand the xml response is to punch some examples into the demo page and examine the output.
