Export a calendar (.ics)

Description

Exports information about meetings and/or sessions in an .ics (calendar) file

HTTP Method

GET

Path

/object/schedule/export

Authentication

Requires an authenticated user.

Parameters

Table 42.  Parameters for " Export a calendar (.ics) "

NameTypeValue TypeDescription
campaignIdQUERYLongthe ID of the campaign retrieve the calendar for
accountIdQUERYLong(optional) the ID of the account to retrieve the schedule for. This will only work if the request is performed for retrieving the schedule in the context of a campaign and if the user making the request has permissions to manage that campaign.
guestOrOwnerQUERYBoolean(optional) if 'true' it will return objects owned by the user or in which is registered as guest.
includeObjectIdsQUERYString(optional) only the provided identifiers of sessions/meeting will be considered. The 'includeMeeting' and 'includeSessions' arguments will be ignored if present
includeMeetingsQUERYBoolean(evaluated only if 'includeObjectIds' is missing. optional, but it should be true if 'includeSessions' is missing or false) true if the meetings should be included
includeSessionsQUERYBoolean(evaluated only if 'includeObjectIds' is missing. optional, but it should be true if 'includeMeetings' is missing or false) true if the sessions should be included
icsFormatQUERYBoolean(optional) true to return an ICS file as attachment.

Error Codes

130004 ( Object )

The type paramater is not a valid object type.

150000 ( Common )

An unhandled exception has occured.

150001 ( Common )

The endpoint requires an authenticated account

150002 ( Common )

Don't have the permission to execute this request

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="icsSchedule">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="campaignId" type="xs:long"/>
        <xs:element name="accountId" type="xs:long"/>
        <xs:element name="includeObjectIds" type="xs:string"/>
        <xs:element name="hasMeetings" type="xs:boolean"/>
        <xs:element name="hasSessions" type="xs:boolean"/>
        <xs:element name="ics" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<icsSchedule xmlns="http://xsd.poken.com">
	<campaignId>12345</campaignId>
	<accountId>123456</accountId>
	<hasMeetings>true</hasMeetings>
	<hasSessions>true</hasSessions>
	<ics></ics>
</icsSchedule>