You
often need to locate the
sco-id
of a meeting so
that you can invite users, get report information about it, or update
it in some other way.
You should understand the structure of folders in which meetings
can be stored. By default, meetings are stored in the host’s My
Meetings folder (called
my-meetings
in the API).
For more details on the folder structure, see
Characteristics of SCOs
.
Find the sco-id of a meeting
-
Call
sco-shortcuts
:
https://example.com/api/xml?action=sco-shortcuts
-
Parse the response for the
sco-id
of a meetings
folder that is likely to contain the meeting:
<sco tree-id="624530" sco-id="624530" type="user-meetings">
<domain-name>http://example.com</domain-name>
</sco>
The folder name should be
meetings
,
user-meetings
,
or
my-meetings
. Use a folder as far down the tree
as you can.
-
Call
sco-contents
on the folder, adding
a filter or two to reduce the response:
https://example.com/api/xml?action=sco-contents&sco-id=2006258750
&filter-type=meeting&filter-name=Intro to Film
-
The more specific you can make the filters, the better. Good
filters to use are
filter-name
,
filter-url-path
,
or a date filter. Be careful with using
filter-like-name
,
as it might affect system performance.
-
You can also call
sco-expanded-contents
to
list subfolders and their contents. However,
sco-contents
is
better for server performance, if you know the
sco-id
of
the folder that contains the meeting.
-
Parse the response for the
sco-id
of the
meeting:
<sco sco-id="2006743452" source-sco-id="-1625529" folder-id="2006258750"
type="meeting" icon="meeting" display-seq="0" is-folder="0">
<name>Intro to Film</name>
<url-path>/film/</url-path>
<date-begin>2006-06-09T14:00:00.000-07:00</date-begin>
<date-end>2006-06-09T20:00:00.000-07:00</date-end>
<date-modified>2006-06-09T14:07:13.767-07:00</date-modified>
<duration>06:00:00.000</duration>
</sco>
List all meetings on the server
Call
report-bulk-objects
with
type=meeting
:
https://example.com/api/xml?action=report-bulk-objects&filter-type=meeting
The
response has a row element for each meeting, showing the meeting
URL, name, and dates:
<row sco-id="2007372149" type="meeting">
<url>/monday/</url>
<name>Monday Staff Meeting</name>
<date-created>2006-12-18T14:15:00.000-08:00</date-created>
<date-end>2006-12-19T02:15:00.000-08:00</date-end>
<date-modified>2006-12-18T17:38:11.660-08:00</date-modified>
</row>
|
|
|