Method

Parameters

Description

Add Calendar Subscription subscribes the user to the given calendar.

Calendar ID

Adds a subscription to a specific calendar ID. This parameter is used to locate the event that you want to try and modify.

Error Code

Returns the Magic xpi error code.

Add User to Access Control adds a user to the Access Control List and sets the user's access rights.

Calendar ID

Adds a user and the user's access rights to the Access Control List of a specific calendar ID.

User

The user that you want to add to the Access Control List. Enter the user's valid Gmail address, such as: xyz@gmail.com.

Right

Select one of the following access rights, as per user classification, from the drop-down list:

• FREEBUSY

• READ

• EDITOR

• OWNER

Error Code

Returns the Magic xpi error code.

Create Calendar creates a new secondary calendar. (It is not possible to create a user's primary calendar.)

Title

The calendar's title.

Description

The calendar's description.

Location

The calendar's location.

Time Zone

The calendar's time zone. For example: "America/Los_Angeles".

Is Hidden

Determines whether the calendar is shown in the interface. Select one of the following options from the drop-down list:

• False

• True

Is Selected

Determines whether the calendar is selected in the interface. Select one of the following options from the drop-down list:

• False

• True

Color

The calendar's user interface color.

Calendar ID

The newly created calendar's Atom ID.

Error Code

Returns the Magic xpi error code.

Create Calendar Event creates a single new calendar event in the specified Google Calendar.

Calendar ID

Specifies a calendar account other than the primary (default) account.

Title

The title of the event.

Description

The description of the event.

Location

The location of the event.

All Day Event

Determines whether the event lasts all day. Select one of the following options from the drop-down list:

• No (default)

• Yes

Since version: V3.1 SP1

Event Start Date

The event start date.

Event Start Time

The event start time.

Duration In Minutes

The event duration.

Event End Date

The event's end date.

This parameter is available only if the All Day Event parameter is set to Yes.

Event Repeats

Select your preferred event repeat interval from the drop-down list:

• No Repeats

• Daily

• Weekly

• Monthly

• Yearly

Repeats Every

The iteration frequency of the value selected in the Event Repeats parameter.

This parameter is available only if the Event Repeats parameter is not set to No Repeats.

Repeat End Date

The end date of the event. If this field contains no value, the repeat will not end.

This parameter is available only if the Event Repeats parameter is not set to No Repeats.

Repeat Weekly On

Enter a number to set the day on which your event will repeat itself each week, as shown below:

• 1=Sunday

• 2=Monday

• 3=Tuesday

• 4=Wednesday

• 5=Thursday

• 6=Friday

• 7=Saturday

For example, if you want the event to repeat itself every Sunday, Wednesday, and Friday, you would enter 1,4,6.

This parameter is available only if the Event Repeats parameter is set to Weekly.

Repeat Monthly On

Select the date on which your event will repeat itself each month from the drop-down list. The valid values are 1-31.

This parameter is available only if the Event Repeats parameter is set to Monthly.

Participants

Enter the email addresses of the participants, separated by commas. Notifications will be sent to all the email addresses that appear in this field.

Reminder Method

Select the way that you want to receive reminders from the Google Calendar from the drop-down list:

• No Reminder (default)

• Default

• Alert

• Email

• SMS

Reminder Period

Enter a numeric value to represent how often you want to receive reminders from the Google Calendar. This value is connected to the Reminder Period Type parameter (below), and is expressed as minutes, hours, days, and weeks.

This parameter is available only if the Reminder Method parameter is set to Alert, Email, or SMS.

Reminder Period Type

Select one of the following reminder period types from the drop-down list:

• Minutes

• Hours

• Days

• Weeks

This parameter is available only if the Reminder Method parameter is set to Alert, Email, or SMS.

Show Event Period As

Shows the availability of the event. Select one of the following options from the drop-down list:

• Available

• Busy (default)

Privacy

Select the required privacy level from the drop-down list:

• Default (default)

• Private

• Public

Extended Properties

You can add extended properties (arbitrary name-value pairs) to calendar events. These can be used to store application-specific IDs or other small amounts of information your application needs when interacting with a Google Calendar. The name of a property can contain up to 47 characters, and the value can contain up to 1024 characters. Extended properties are only accessible through the API – they do not appear in the Calendar user interface. They take a flat file format of <name>,<value>, as per the following examples:

• Pr1,56

• Pr2,user

• Pr3,password

Event ID

The newly created event ID.

Error Code

Returns the Magic xpi error code.

Delete Calendar deletes a calendar for which the user has owner rights.

Calendar ID

The calendar ID that you want to delete.

Error Code

Returns the Magic xpi error code.

Delete Calendar Event deletes calendar events based on Event IDs from the specified Google Calendar. (If the event is repeatable, all occurrences will be deleted.)

Calendar ID

Specifies a calendar account other than the primary (default) account.

Event ID

The ID of the event that you want to delete.

Error Code

Returns the Magic xpi error code.

Delete Calendar Subscription deletes the calendar from the user's account.

Calendar ID

Deletes the user's subscription to this calendar ID.

Error Code

Returns the Magic xpi error code.

Modify Calendar updates a calendar to which the user has owner rights

Calendar ID

The calendar ID that you want to update.

Title

The calendar's title.

Description

The calendar's description.

Location

The calendar's location.

Time Zone

The calendar's time zone. For example: "America/Los_Angeles".

Is Hidden

Determines whether the calendar is shown in the interface. Select one of the following options from the drop-down list:

• False

• True

Is Selected

Determines whether the calendar is selected in the interface. Select one of the following options from the drop-down list:

• False

• True

Color

The calendar's user interface color.

Error Code

Returns the Magic xpi error code.

Modify Calendar Event updates calendar events based on the filter parameters from the specified Google Calendar.

Calendar ID

Specifies a calendar account other than the primary (default) account, based on the associated Google settings. This parameter is used to locate the event that you want to try and modify.

Event ID

The Event ID that you want to update.

Title

The updated title of the event.

Description

The updated description of the event.

Location

The updated location of the event.

All Day Event

Determines whether the updated event's duration is all day or otherwise. Select one of the following from the drop-down list:

• No Change (default)

• No

• Yes

Since version: V3.1 SP1

Event Start Date

The updated event start date.

This parameter is available only if the All Day Events parameter is set to No or Yes.

Event Start Time

The updated event start time.

This parameter is available only if the All Day Events parameter is set to No.

Duration In Minutes

The updated event duration.

This parameter is available only if the All Day Events parameter is set to No.

Event End Date

The event's end date.

This parameter is available only if the All Day Event parameter is set to Yes.

Event Repeats

Select your preferred event repeat interval from the drop-down list:

• No Change (default)

• No Repeats

• Daily

• Weekly

• Monthly

• Yearly

Repeats Every

The iteration frequency of the value selected in the Event Repeats parameter.

This parameter is available only if the Event Repeats parameter is not set to No Repeats.

Repeat Weekly On

Enter a number to set the day on which your event will repeat itself each week, as shown below:

• 1=Sunday

• 2=Monday

• 3=Tuesday

• 4=Wednesday

• 5=Thursday

• 6=Friday

• 7=Saturday

For example, if you want the event to repeat itself every Sunday, Wednesday, and Friday, you would enter 1,4,6.

This parameter is available only if the Event Repeats parameter is set to Weekly.

Repeat Monthly On

Select the date on which your event will repeat itself each month from the drop-down list. The valid values are 1-31.

This parameter is available only if the Event Repeats parameter is set to Monthly.

Repeat End Date

The end date of the event. If this field contains no value, the repeat will not end.

This parameter is available only if the Event Repeats parameter is not set to No Repeats.

Participant Action

Governs what happens to the current email addresses of the participants when the calendar is updated. Select one of the following from the drop-down list:

• No Change (default)

• Add

• Delete (this deletes the addresses specified in the Participants parameter)

• Overwrite

Participants

Enter the email addresses of the participants, separated by commas. Any value in this field adds the participants to the filtered events.

This parameter is available only if the Participants Action parameter is not set to No Change.

Reminder Method

Select the way that you want to receive reminders from the Google Calendar from the drop-down list:

• No Change (default)

• Remove Reminder

• Alert

• Email

• SMS

Reminder Index

This parameter lets you set reminders for a particular event. For example, you can receive one reminder via email two days before the event, and another reminder via SMS 15 minutes before the event.

Select the required reminder index from the drop-down list:

• First Reminder

• Second Reminder

• Third Reminder

• Fourth Reminder

• Fifth Reminder

This parameter is available only if the Reminder Method parameter is set to Remove Reminder, Alert, Email, or SMS.

Reminder Period

Enter a numeric value to represent how often you want to receive reminders from the Google Calendar. This value is connected to the Reminder Period Type parameter (below), and is expressed as minutes, hours, days, and weeks.

This parameter is available only if the Reminder Method parameter is set to Alert, Email, or SMS.

Reminder Period Type

Select one of the following reminder period types from the drop-down list:

• Minutes

• Hours

• Days

• Weeks

This parameter is available only if the Reminder Method parameter is set to Alert, Email, or SMS.

Show Event Period As

Shows the availability of the event. Select one of the following options from the drop-down list:

• No Change (default)

• Available

• Busy

Privacy

Select the required privacy level from the drop-down list:

• No Change (default)

• Default

• Private

• Public

Extended Properties

You can add extended properties (arbitrary name-value pairs) to calendar events. These can be used to store application-specific IDs or other small amounts of information your application needs when interacting with a Google Calendar. The name of a property can contain up to 47 characters, and the value can contain up to 1024 characters. Extended properties are only accessible through the API – they do not appear in the Calendar user interface. They take a flat file format of <name>,<value>, as per the following examples:

• Pr1,56

• Pr2,user

• Pr3,password

Error Code

Returns Magic xpi error code if update has failed.

Modify Calendar Subscription updates the personalization settings of a calendar.

Calendar ID

Updates the subscription to this calendar ID.

Color

The calendar's user interface color.

Is Hidden In UI

Determines whether the calendar subscription is shown in the user interface. Select one of the following options from the drop-down list:

• No Change (default)

• False

• True

Is Selected In UI

Determines whether the calendar is selected in the user interface. Select one of the following options from the drop-down list:

• No Change (default)

• False

• True

Error Code

Returns the Magic xpi error code.

Modify User Access Rights updates the user permissions in the Access Control List of a calendar.

Calendar ID

The ID of the calendar whose Access Control List you want to update.

User

The user that you want to modify in the Access Control List. Enter the user's valid Gmail address, such as: xyz@gmail.com.

Right

Select one of the following access rights, as per user classification, from the drop-down list:

• FREEBUSY

• READ

• EDITOR

• OWNER

Error Code

Returns the Magic xpi error code.

Read Calendar Events query of calendar events based on the filter parameters from the specified Google Calendar.

Calendar ID

Specifies a calendar account other than the primary (default) account, based on the associated Google settings.

Event From Date

The From date range of the event. (If left blank, the assigned value is 01/01/1970.)

Event From Time

The From time range of the event.

Event To Date

The To date range of the event. (If left blank, the assigned value is 01/01/2031.)

Event To Time

The To time range of the event.

Full Text Search

To do a text search across all the calendar event fields, and to retrieve the relevant results, enter the required text here.

Read As Single Events

Determines whether to read the event as a single event. Select one of the following options from the drop-down list:

• Yes (default)

• No

Output Type

The output type of the retrieved events. Select one of the following options from the drop-down list:

• File (default)

• BLOB

Output Structure

The format in which the retrieved events will be outputted. Select one of the following options from the drop-down list:

• XML (default)

• Flat File

Output To File

Enter the full file path of the file that will hold the retrieved events

This parameter is available only if the Output Type parameter is set to File.

Output

This parameter lets you select a BLOB variable in which to hold an XML or a Flat File.

This parameter is available only if the Output Type parameter is set to BLOB.

Error Code

Returns the Magic xpi error code.

Remove User Access removes a user from a calendar's Access Control List.

Calendar ID

The ID of the calendar from which you want to remove a user's access rights.

User

The user whose access rights you want to remove.

Enter the user's valid Gmail address, such as: xyz@gmail.com.

Error Code

Returns the Magic xpi error code.

Retrieve Access Control List generates a comma delimited list of each user and his or her access rights to the calendar.

Calendar ID

The identifying calendar's ID.

Users Rights List

A comma delimited flat file of <user>,<access right>. Access rights, as per user classification, are of the following types:

• FREEBUSY (this user can only see free/busy information)

• READ (this user can see all event details)

• EDITOR (this user can make changes to events)

• OWNER (this user can make changes and manage sharing)

Error Code

Returns the Magic xpi error code.

Retrieve Calendar List retrieves the list of calendars that appear in the user’s Google Calendar user interface.

List Type Filter

Governs which calendars appear in the list of retrieved calendars. Select one of the following options from the drop-down list:

• All Calendars (primary, secondary, and imported calendars)

• Own Calendars (primary and secondary calendars only)

Output Type

The output type of the retrieved calendar lists. The output is only in XML format. Select one of the following options from the drop-down list:

• File (default)

• BLOB

Output To File

Enter the full file path of the file that will hold the retrieved events

This parameter is available only if the Output Type parameter is set to File.

Output

This parameter lets you select a BLOB variable in which to hold an XML or a Flat File.

This parameter is available only if the Output Type parameter is set to BLOB.

Error Code

Returns the Magic xpi error code.