Calendar Method


The calendar method allows you to access an accounts scheduled tasks.

Base Url

GET   http://www.reefware.com/api/request/v1/calendar

Response

{ id: [task_id],
name: [task_name],
category: [task_category],
date: [task_date],
start: [start_time],
startType: [start_meridiem],
stop: [stop_time],
stopType: [stop_meridiem],
day: [all_day_event],
priority: [task_priority],
status: [task_status],
desc: [task_description],
pattern: [task_repeat_pattern],
token: [task_token],
alert: [task_notification],
sent: [notification_sent]
}


Data Options

id
optional

  • 'id' will return the task id.
  • The task id is unique for each saved event.
  • This option will return as a number.

This option can't be changed.

name
optional

  • 'name' will return the task name.
  • This option will return as a string.

category
optional

  • 'category' will return the category id number.
  • This option will return as a number.

date
optional

  • 'date' will return the start/added date for the task.
  • This option will return as a date timestamp.

start
optional

  • 'start' will return the start time.
  • This option will return as a date timestamp.

startType
optional

  • 'startType' will return the start time meridiem.
  • This option will return as a string.
  • The response for this option will return as "pm" or "am"

stop
optional

  • 'stop' will return the stop time.
  • This option will return as a date timestamp.

stopType
optional

  • 'stopType' will return the stop time meridiem.
  • This option will return as a string.
  • The response for this option will return as "pm" or "am"

day
optional

  • 'day' will return as a '0' or '1'.
  • '0' means this event is not scheduled for all day.
  • '1' means this event is scheduled for all day.

priority
optional

  • 'priority' will return the priority valye for this task.
  • The priority value sets the order of tasks on a specific day.
  • The response for this option will return as a number.

status
optional

  • 'status' will return a value to check if a task is active or inactive.
  • '0' means the task is inactive.
  • '1' means the task is active.

desc
optional

  • 'desc' will return the task text description.
  • The response for this option will return as a string.

pattern
optional

  • 'pattern' will display how often the task will repeat.
  • The available options are never, daily, weekly, monthly, or yearly.
  • The response for this option will return as a string.

token
optional

  • 'token' will display the token generated for the task.
  • The response for this option will return as a string.

This option can't be changed.

alert
optional

  • 'alert' will show if a notification should be sent for this task.
  • '0' means that a notification will not be sent.
  • '1' means a notification will be sent.

sent
optional

  • 'sent' will show if a notification has been sent through SMS or email.
  • '0' means that a notification has not been sent.
  • '1' means a notification has been sent.

 

Example Request

GEThttp://www.reefware.com/api/request/v1/calendar/data/start.startType.pattern

Response

  1. [
  2. [
  3. {
  4. "start": 18:15:00,
  5. "startType": "pm",
  6. "pattern": "weekly"
  7. }
  8. ]
  9. ]