sco-update

Availability

Breeze 4 and Breeze 5; Connect Enterprise Web Services 6

Description

Creates metadata for a SCO, or updates existing metadata describing a SCO.

Call sco-update to create metadata only for SCOs that represent content, including meetings. You also need to upload content files with either sco-upload or Connect Enterprise Manager.

You must provide a folder-id or a sco-id, but not both. If you pass a folder-id, sco-update creates a new SCO and returns a sco-id. If the SCO already exists and you pass a sco-id, sco-update updates the metadata describing the SCO.

After you create a new SCO with sco-update, call permissions-update to specify which users and groups can access it.

Request URL

http://server_name/api/xml
    ?action=sco-update
    &author-info-1=string
    &author-info-2=string
    &author-info-3=string
    &date-begin=datetime
    &date-end=datetime
    &description=string
    &email=string
    &first-name=string
    &folder-id=integer
    &icon=allowedValue
    &lang=allowedValue
    &last-name=string
    &name=string
    &sco-id=integer
    &sco-tag=string
    &source-sco-id=integer
    &type=allowedValue
    &url-path=string
    &session=BreezeSessionCookieValue

Parameters

Name	Type	Required	Description
`author-info-1`	String	N	Information about the author. Used only with presentations. Can be used for the author's name or any other information.
`author-info-2`	String	N	Additional information about the author. Used only with presentations. Can be used for the author's professional title or any other information.
`author-info-3`	String	N	Additional information about the author. Used only with presentations. Can be used for the author's company name or any other information.
`date-begin`	Datetime	N	The scheduled beginning date and time, in ISO 8601 format. Used only for meetings and courses.
`date-end`	Datetime	N	The scheduled ending date and time, in ISO 8601 format. Used only for meetings and courses.
`description`	String	N	A description of the SCO to be displayed in the user interface.
`email`	String	N	The e-mail address of the contact person for a presentation (used only with presentation SCOs).
`first-name`	String	N	The first name of the contact person for a presentation (used only with presentation SCOs).
`folder-id`	Integer	Y/N	The ID of the folder in which a new SCO will be stored. Required for a new SCO, but do not use for an existing SCO.
`lang`	Allowed value	N	An abbreviation for the language associated with the SCO (see lang for values). If not specified, the default value for the folder in which the SCO is created is used.
`icon`	Allowed value	N	The visual symbol used to identify a SCO in Enterprise Manager; also provides information about the SCO in addition to its type.
`last-name`	String	N	The last name of the contact person for a presentation (used only with presentations).
`name`	String	Y/N	The name of the SCO, with or without spaces. Required to create an SCO.
`sco-id`	Integer	Y/N	The unique ID of a SCO to update. Use `sco-id` or `folder-id`, but not both. Required to update an existing SCO.
`sco-tag`	String	N	A label for any information you want to record about a course. Use only with courses.
`source-sco-id`	Integer	N	The unique ID of a template you can use to create a meeting or a piece of content from which you can build a course.
`type`	Allowed value	N	The type of the new SCO (for allowed values, see type). The default value is `content`.
`url-path`	String	N	The custom part of the URL to the meeting room that comes after the domain name. The `url-path` must be unique within the folder. If not specified, the server assigns a value.
`session`	String	N	The value of the `BREEZESESSION` cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code=allowedValue /> 
    <sco folder-id=integer lang=allowedValue type=allowedValue 
            sco-id=integer version=integer account-id=integer icon=integer>
        <url-path>string</url-path> 
        <description>string</description> 
        <name>string</name> 
    </sco>
</results>

Response values

Element	Attribute	Type	Description
`results`		Container	All results the action returns.
`status`		Empty, with attributes	The status of the response.
	`code`	Allowed value	A code indicating the response status (see status).
`sco`		Container	Information about a new SCO just created, including the `sco-id`. Returned only if you create a SCO.
	`folder-id`	Integer	The ID of the folder in which the new SCO is stored.
	`lang`	Allowed value	A code for the language associated with the SCO (see lang for values).
	`type`	Allowed value	The type of the new SCO (see type for values).
	`sco-id`	Allowed value	The unique ID of the new SCO.
	`version`	Integer	The version number of the new SCO. When the SCO is first created, the `version` is `0`.
	`account-id`	Integer	The ID of the account in which the new SCO is created.
	`icon`	Integer	The type of icon that identifies a new SCO in Connect Enterprise Manager (see icon for values).
`url-path`		String	The part of the SCO URL that comes after the domain name and uniquely identifies the SCO.
`description`		String	A text description of the SCO.
`name`		String	The name of the SCO.

Sample request

https://example.com/api/xml?action=sco-update&folder-id=2006258747
    &description=test&name=More About Web Communities&type=content
    &lang=en

Sample response

<?xml version="1.0" encoding="utf-8" ?> 
<results>
    <status code="ok" /> 
    <sco folder-id="2006258747" account-id="624520" type="content" lang="en"
            icon="content" sco-id="2006752036" version="0">
        <url-path>/p53884157/</url-path> 
        <description>test</description> 
        <name>More About Web Communities</name> 
    </sco>
</results>