Share via

AddMeetingFromICal Method

  • Article

AddMeetingFromICal Method

The AddMeetingFromICal method of the Meetings service associates a meeting represented in Internet Calendar (iCal) format with the Meeting Workspace site on the specified Microsoft Windows SharePoint Services server.

Parameters

organizerEmail   The e-mail address, specified as email_address@domain.ext, for the meeting organizer.

icalText   The iCal representation of the meeting that will be associated with the Meeting Workspace site.

Return Value

A Microsoft.SharePoint.SoapServer.SoapXml object that contains the following:

<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

<soap:Body>

<AddMeetingFromICalResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/">

<AddMeetingFromICalResult>

<AddMeetingFromICal Url="http://server_name/Test Meeting(2)?InstanceID=1" HostTitle="Team Web Site" UniquePermissions="true" MeetingCount="1" AnonymousAccess="false" AllowAuthenticatedUsers="false" />

</AddMeetingFromICalResult>

</AddMeetingFromICalResponse>

</soap:Body></soap:Envelope>

Url   The Url to the Meeting Workspace site that you added the meeting to. It contains a query string that gives you the InstanceID of the meeting added.

InstanceID   Identifies this meeting instance in the site that contains single instance meetings. If the site contains a recurring meeting, '?InstanceID=' is not appended to the Url. 'AdMode=1' may be appended to the Url as a query string if this site is configured in AdAccountCreation mode.

HostTitle   The title of the parent site; if the title of the parent is an empty string, this would return the Url of the parent.

UniquePermissions  true or false, indicating whether this site was created with unique permissions.

MeetingCount   Returns the number of meetings associated with this workspace. If this workspace contains a recurring meeting, this will return -1.

AnonymousAccess  true or false, indicating whether the Allow Anonymous Access feature has been enabled on this workspace.

AllowAuthentictedUsers   true or false, indicating whether Allow Authenticated Users feature has been enabled on this workspace.

Remarks

The organizerEmail   parameter is used in delegate scenarios to indicate the organizer of the meeting. If the meeting organizer is not a delegate, it is an empty string.

Exceptions

This method will only work with Meeting Workspace sites. If you try and call this method against a non-Meeting Workspace site, this method will generate a SOAP exception. The exception will look like this:

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Body>

    <soap:Fault>

      <faultcode>soap:Server</faultcode>

      <faultstring>Exception of type Microsoft.SharePoint.SoapServer.SoapServerException was thrown.</faultstring>

      <detail>

        <errorstring xmlns="http://schemas.microsoft.com/sharepoint/soap/">Your attempt to add a meeting to a Meeting Workspace could not be completed. The specified location is not a Meeting Workspace. Specify a different location or contact the Web site administrator.</errorstring>

        <errorcode xmlns="http://schemas.microsoft.com/sharepoint/soap/">0x00000006</errorcode>

      </detail>

    </soap:Fault>

  </soap:Body>

</soap:Envelope>

SOAP Request Format

The following is a sample SOAP request. The placeholders shown need to be replaced with actual values.

POST /_vti_bin/meetings.asmx HTTP/1.1
Host: server_name
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/sharepoint/soap/meetings/AddMeetingFromICal"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddMeetingFromICal xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/">
      <organizerEmail>string</organizerEmail>
      <icalText>string</icalText>
    </AddMeetingFromICal>
  </soap:Body>
</soap:Envelope>

SOAP Response Format

The following is a sample SOAP response. The placeholders shown will be replaced with actual return values.

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <AddMeetingFromICalResponse xmlns="http://schemas.microsoft.com/sharepoint/soap/meetings/">
      <AddMeetingFromICalResult>
        <xsd:schema>schema</xsd:schema>xml</AddMeetingFromICalResult>
    </AddMeetingFromICalResponse>
  </soap:Body>
</soap:Envelope>

Requirements

Platforms: Microsoft Windows Server 2003

Web Reference: http://Server_Name/[sites/][Site_Name/]_vti_bin/Meetings.asmx