Spec - Calendars

Table Of Contents

• Get Calendars
• Get Calendar Ics Link

Get Calendars

This function allows the caller to retrieve a list of calendars of a group.

Input

• account_id
• group_id
• group_name

Output

Success or failure. On success returns a list of calendars of a group.

Example Request

<GetCalendarsRequest group_id="4"></GetCalendarsRequest>

Successful Response

<GetCalendarsResponse>
    <Result>Success</Result>
    <Calendars>
        <Calendar>
            <Calendar_id>4</Calendar_id>
            <Title>2014-2015</Title>
            <ActiveNow>Y</ActiveNow>
            <TotalActiveContacts>501</TotalActiveContacts>
        </Calendar>
        <Calendar>
            <Calendar_id>6</Calendar_id>
            <Title>Fall 2014</Title>
            <ActiveNow>Y</ActiveNow>
            <TotalActiveContacts>501</TotalActiveContacts>
        </Calendar>
    </Calendars>
</GetCalendarsResponse>

Get Calendar Ics Link

This function allows the caller to retrieve a link to download all of the events on a user’s private calendar. The link specifies a URL to an .ics file which can be used by most calendaring programs.

Input

group_id and user_email of the user owning the calendar being request. account_id if shared_access. If missing, account id defaults to account the caller is an owner of.

Output

Success or failure. On success IcsURL specifying the URL (without http:// or webcal://) of the calendar for download.

Example Request 1

<GetCalendarIcsLinkRequest group_id="8" user_email="useremail@yourdomain.com"></GetCalendarIcsLinkRequest>

Example Request 2 (shared access)

<GetCalendarIcsLinkRequest account_id="1234" group_id="8" user_email="useremail@yourdomain.com"></GetCalendarIcsLinkRequest>

Successful Response

<GetCalendarIcsLinkResponse>
    <Result>Success</Result>
    <IcsURL>app.domain.com/privcal2.ics?d482a0998c22a0999bc279105be151269804c52</IcsURL>
</GetCalendarIcsLinkResponse>