6Channel6 Reminder Web Service Guide

References of 6Channel6 Reminder Web Service are located at http://www.6channel6.com/WebAPI.aspx

It only takes one call to create a reminder. The method is CreateReminder, with two parameters: license object and reminder object.

A reminder is basically an upcoming event (what message to be sent), with a predefined date time to remind (when), who to remind, and what devices to receive the message (how).

A reminder can be sent to self (User), and/or other people (Contacts).

The only way to verify the result of a reminder created from the API is by checking the calendar on the web site.

The CreateReminder returns Result object, which contains either an error message when there is a problem, or an URL of the details of reminder just created.

Result object

Two fields:

• ErrorMessage string – when the call fails
• ReminderDetailUrl string – details page of the reminder just created

Reminder object

Four fields

• Event object – required
• RemindDatetTime string – optional
• User object – optional
• Contacts object array – optional

Event object

Everything of a schedule event:

• date and time of an event
• subject and detailed descrption of the event
• if the event recurs and how does it repeat
• when does the recurrence end

Five fields:

• EventDateTime, subject – key (maximum 50 characters)
• Description – optional, maximum 1024 chracters, for long message
• RepeatOptionString – optional, case sensitive
• RepeatEndDateString– optional, date part only, should not include time

User object

• UserId - key
• Devices object array - required

Contact object

• FirstName, MiddleName, LastName - key (max 50 characters each)
• Devices - object array, required

When FirstName and LastName are duplicated, use MiddleName to distinguish.

The contact’s name is used in the greeting of the reminder sent.

Contacts object array

An array of Contact object.

Device object

• DeviceType - key (only one device for each type)
• DeviceAddress – required (maximum 50 characters)
• ServiceProviderName - only required for SMS device

Devices object array

An array of Device object.

Maximum 10 elments, meaning 10 devices, 10 types, one device of each type.

Device Type List:

• HomeEmail
• WorkEmail
• HomePhone
• WorkPhone
• CellPhone
• SMS (text message)
• AIM (AOL instant messenger)
• MSN (MSN instant messenger)
• YAHOO (Yahoo! instant messenger)
• Fax

Repeat Option List:

• None
• Daily
• Weekly
• Once Every Two Weeks
• Monthly
• Weekdays Only
• Weekends Only
• Quarterly
• Semi Annually
• Annually

SMS Provider List:

• Alltel
• AT&T PCS
• Bell Atlantic
• Bell Mobility (Canada)
• Cellular One
• Cingular Wireless
• Comcast
• Fido
• Nextel
• Omnipoint
• Qwest
• Rogers Wireless
• Sprint PCS
• T-Mobile
• Telus
• Verizon
• Virgin Mobile 

Terms related to device:

The term device is used to describe all communication means, such as phone, email, text message, instant message, fax, pager/beeper, blog, and RSS feed.

No distinction is made on whether a phone device is a traditional wired phone, cell phone, or modern IP phone; whether an email device is regular desktop PC, PDA, two way pager, or Blackberry; whether a fax device is an old fashion fax machine, fax Modem, or e-fax; or whether an instant message device is a PC, PDA, cell phone, or X-Box game console.

Among all the communication means, phone, email, text message, instant message, fax, and pager, are able to receive point to point notification message. They are generically called as notification devices.

Phone numbers, email addresses, text message numbers, instant messenger accounts, fax numbers, and pager numbers are then uniformly called as device addresses.