LuxSci API: WebAide Definitions

General Definitions

`webaide_type`

A code that identifies one of the supported types of WebAides. Currently these codes include:

calendars tasks addressbooks notes links

Other WebAide types are not yet exposed through the API.

`webaide_permission`

Access permissions a user can have on a specific WebAide. Possible values include:

admin – administrative access (e.g. all access)
read – Can read entries
create -- Can make new entries
edit_self – Can edit entries created by the user him/herself
edit_all – Can edit any entry
add_self – Can make comments on entries created by the user him/herself
add_all – Can comment on any entry
delete_self -- Can delete entries created by the user him/herself
delete_all – Can delete any entry

WebAide entry data fields

Individual WebAide entries consist of a number of different fields (properties). Each kind of WebAide has a different set of fields. The following tables define the fields for each WebAide type. The name of the “field” is used when retrieving and uploading entry data via the API. Some values must obey a particular data format: this information is also indicated in these tables. Note that the field names are case sensitive.

Common Fields

Fields types common to all WebAides types.

Field

Type

Description and requirements

Categories

Comma-delimited string

Semi-colon-delimited list of Tags (categories).
E.g. “tag1;tag2”.

Categories should not contain spaces, commas, or semi-colons.

Unique ID

INTEGER

Unique ID of this particular entry. This is also known as the “entry_id”.

addressbooks

Address books have the common fields, plus those below.

Field	Type	Description and requirements
Created	DATETIME	Date and time the entry was created, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Modified	DATETIME	Date and time the entry was last changed, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Account	Text
Anniversary	Text
Assistant’s Name	Text
Assistant’s Phone	Text
Birthday	Text
Business Address PO Box	Text
Business City	Text
Business Country	Text
Business Fax	Text
Business Phone	Text
Business Phone 2	Text
Business Postal Code	Text
Business State	Text	State/province
Business Street	Text	Business Address Fields
Business Street 2	Text
Business Street 3	Text
Callback	Text
Car Phone	Text
Children	Text
Company	Text	Organization
Company Main Phone	Text
Department	Text	In the Company
E-mail Address	Comma-delimited lists of emails	Primary email address.
E-mail Address 2	Comma-delimited lists of emails
E-mail Address 3	Comma-delimited lists of emails
File As	Text	This field corresponds to the entry’s “title”
First Name	Text
Gender	Text
Government ID Number	Text
Hobby	Text
Home Address PO Box	Text
Home City	Text
Home Country	Text
Home Fax	Text
Home Phone	Text
Home Phone 2	Text
Home Postal Code	Text
Home State	Text
Home Street	Text	Home Address Fields
Home Street 2	Text
Home Street 3	Text
IM Address	Text	Instant Messenger / Chat address
ISDN	Text
Job Title	Text
Language	Text
Last Name	Text
Location	Text
Manager’s Name	Text
Middle Name	Text
Mileage	Text
Mobile Phone	Text	Primary cell phone number for contact
Nickname	Text
Notes	HTML	Free-form HTML comments on this contact
Office Location	Text
Organizational ID Number	Text
Other Address PO Box	Text
Other City	Text
Other Country	Text
Other Fax	Text
Other Phone	Text
Other Postal Code	Text
Other State	Text
Other Street	Text	Other address fields
Other Street 2	Text
Other Street 3	Text
Pager	Text
PGP Public Key	Text	ASCII-armored PGP public key for “SecureLine Email”
Picture	JPEG	Profile picture. Base64-encoded JPEG picture data.
Primary Phone	Text	Main phone number for contact
S/MIME Public Key	Text	ASCII-armored S/MIME public key for “SecureLine Email”
SecureLine Email	EMAIL	Email address for encrypted messages
SecureLine Escrow Answer	Text	Answer in plain text or as a hash of the answer (lower cased version of the answer text)
SecureLine Escrow Question	Text	Plain text question
SecureLine Mode	ENUM	SecureLine mode to be used for encryption:
“none”, “escrow”, “pgp”, “smime”
SMS/Text Address	Text
Spouse	Text	Spouse’s name
Suffix	Text	E.g. “Senior”
Title	Text	E.g. “Mr.” or “Dr”. or “Miss”
User 1	Text	Custom Field 1
User 2	Text	Custom Field 2
User 3	Text	Custom Field 3
User 4	Text	Custom Field 4
Web Page	Text	Web Site URL

Calendars

Calendars have the common fields, the recurrence fields, plus those below.

Field	Type	Description and requirements
DateTime Created	DATETIME	Date and time the entry was created, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Modified DateTime (GMT)	DATETIME	Date and time the entry was last changed, in GMT in the format “YYYY-MM-DD HH:MM:SS”
All day event	Enum	Can be “yes” or “no” if the calendar event lasts “all day” on the date of the “Start DateTime”. Default is “no”.
Billing Information	Text
Companies	Text
Description	HTML	HTML-formatted notes about this event.
End DateTime	DATETIME	When the first occurrence of this event ends. If you omit this on entry creation, then the entry will default to 1 hour in duration.
Internal 1	Text	Internal/system data.
Internal 2	Text	Internal/system data.
Internal 3	Text	Internal/system data.
Location	Text
Priority	Enum	Can be “normal”, “low”, or “high”
Private	Enum	Can be “yes” or “no”
Resources	Text
Show Time As	Enum	Can be “Busy”, “Tentative”, “Free”, or “Out of Office”
Start DateTime	DATETIME	Required. When the first occurrence of this event begins (GMT, “YYYY-MM-DD HH:MM:SS”)
Subject	Text	Required. Event title

Tasks

Tasks have the common fields, the recurrence fields, plus those below.

Field	Type	Description and requirements
DateTime Created	DATETIME	Date and time the entry was created, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Modified DateTime (GMT)	DATETIME	Date and time the entry was last changed, in GMT in the format “YYYY-MM-DD HH:MM:SS”
% Complete	Percentage	Percentage of completeness from: 0% – 100%
Actual Work	Text
Billing Information	Text
Companies	Text
Contact	Text
DateTime Completed	DATETIME	For tasks that have been marked complete, this is the Date/Time when that happened.
(GMT, “YYYY-MM-DD HH:MM:SS”)
Description	HTML	HTML-formatted notes about this event.
Due DateTime	DATETIME	Required. When the first occurrence of this task is due (GMT, “YYYY-MM-DD HH:MM:SS”)
Mileage	Text
Priority	Enum	Can be “normal”, “low”, or “high”
Private	Enum	Can be “yes” or “no”
Role	Text
Sensitivity	Text
Status	Enum	Can be “not_started”, “in_progress”, “completed”, “waiting”, or “deferred”
Subject	Text	Required. Title for the task entry
Total Work	Text

Notes

Field	Type	Description and requirements
Date Created	DATETIME	Date and time the entry was created, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Date Modified	DATETIME	Date and time the entry was last changed, in GMT in the format “YYYY-MM-DD HH:MM:SS” (for Links, Notes, Address Books).
Body	HTML	Raw HTML of the note content
Plain Text Notes	Text	Plain text version of the entry’s not content.
Auto-converted from the HTML in Body.
Title	Text	Required. Note title

Links

Field	Type	Description and requirements
Date Created	DATETIME	Date and time the entry was created, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Date Modified	DATETIME	Date and time the entry was last changed, in GMT in the format “YYYY-MM-DD HH:MM:SS”
Link Title	Text	Required. Arbitrary text title for this link.
URL	Text	Required. Web site address

Recurrence

For calendar and task entries that sport recurrence, some or all of the following fields may be used. Some fields are required if recurrence is to be enabled. These are denoted as “Required”. Other fields are also required, but conditionally based on the choices in these fields. If you get it wrong, our will get an error or recurrence will not be added to the event (depending on the error).

Field	Type	Description
Recur Enabled	Enum	Required. Can be “yes” or “no”. If recurrence is enabled.
Recur Timezone	TIMEZONE	Time zone to use for generating the recurrence pattern. E.g. “GMT” or “EST5EDT”. If omitted, this defaults to GMT.
Recur Freq Type	Enum	Required. Type of recurrence. Can be “daily”, “weekly”, “monthly”, “yearly”
Recur End Type	Enum	Required. Can be “n” (for ending after ‘n’ times), “date” (for ending by a specified date), or “none” (for perpetual recurrence)
Recur End By Date	DATE	End by date if ‘Recur End Type’ is “date”. YYYY-MM-DD.
Recur N Times	INTEGER	Number of times to recur if ‘Recur End Type’ is “n”
Recur Exclude Dates	Comma- delimited DATEs	Simple CSV list of dates or date-times to be excluded from the recursion pattern. If times are provided, it assumes the date/time is in the time zone of the user doing the synching (as per the time zone option). If the time is omitted, it assumes the date is appropriate to the event time in the time zone of the user doing the synching (as per the time zone option).
Daily Recur Type	Enum	Type of daily recurrence. Can be “ndays” (to recur every ‘n’ days), or “weekdays” (to recur every weekday). For Task WebAides, this can also be “regen” which regenerates a new Task “Recur Regenerate Days” after this task is marked complete.
Recur Every N Days	INTEGER	Number of days between recurrences if ‘Daily Recur Type’ is “ndays”
Recur Regenerate Days	INTEGER	(regen) Days after the task is marked complete to generate a new similar task.
Weekly Recur Type	Enum	Type of weekly recurrence. Can be “nweeks” (to recur every ‘n’ weeks). For Task WebAides, this can also be “regen” which regenerates a new Task “Recur Regenerate Weeks” after this task is marked complete.
Weekly Recur Days	Comma- delimited integers	CSV list of days on which to recur for weekly recurrence. Days are 0-6 with 0=Sunday and 6=Saturday. For example, “0,1,3” indicates a recurrence pattern of Sunday, Monday, and Wednesday.
Recur Every N Weeks	INTEGER	Number of weeks between recurrences. Required if ‘Weekly Recur Type’ is “nweeks”
Recur Regenerate Weeks	INTEGER	(regen) Weeks after the task is marked complete to generate a new similar task.
Monthly Recur Type	Enum	Type of monthly recurrence. Can be “dayn” (for example, to recur on the 14th), or “rel” (for example, to recur on every 2nd Monday). For Task WebAides, this can also be “regen” which regenerates a new Task “Recur Regenerate Months” after this task is marked complete.
Monthly Recur Day Number (dayn)	INTEGER	Day number for recurrence. For example, “24”. For Monthly recurrence type of “dayn”. Value: 1..31.
Recur Every N Months (dayn)	INTEGER	For “dayn” recurrence, the number of months between instances.
Monthly Recur Order (rel)	Enum	Relative order of the recurrence day. Can be “1st”, “2nd”, “3rd”, “4th”, or “5th”
Monthly Recur Day of Week (rel)	INTEGER	Day of week for recurrence. Days are 0-6 with 0=Sunday and 6=Saturday. For example, “3” indicates Wednesday
Recur Every N Months (rel)	INTEGER	Number of months between recurrences if ‘Monthly Recur Type’ is “rel”
Recur Regenerate Months	INTEGER	(regen) Months after the task is marked complete to generate a new similar task.
Yearly Recur Type	Enum	Type of yearly recurrence. Can be “dayn” (for example, to recur on every February 23rd), or “rel” (for example, to recur on every 3rd Thursday in February). For Task WebAides, this can also be “regen” which regenerates a new Task “Recur Regenerate Years” after this task is marked complete.
Yearly Recur Day of Week (rel)	INTEGER	Day of week for recurrence. Days are 0-6 with 0=Sunday and 6=Saturday. For example, “3” indicates Wednesday
Yearly Recur Month (dayn)	INTEGER	Month number for yearly recurrence if ‘Yearly Recur Type’ is ‘dayn’. Can be 1-12, with 1=January
Yearly Recur Day Number (dayn)	INTEGER	Day number for yearly recurrence if ‘Yearly Recur Type’ is ‘dayn’. For example, “24”
Yearly Recur Order (rel)	Enum	Relative order of the recurrence day. Can be “1st, “2nd, “3rd”, “4th, or “5th”
Yearly Recur Month (rel)	INTEGER	Month number for yearly recurrence if ‘Yearly Recur Type’ is ‘rel’. Can be 1-12, with 1=January.
Recur Regenerate Years	INTEGER	(regen) Years after the task is marked complete to generate a new similar task.

< API Overview Page

LuxSci API: WebAideTM Definitions