Name
Last updated on
May 15, 2021
Availability
Breeze 4
Description
Moves a SCO from one folder to another.
To move a SCO to a folder, the current user must have permission to create content in the target folder. In general, users have permission on their own folders (such as my-meetings, my-courses, my-events, my-content, and my-meeting-templates) by default. To move SCOs to a shared folder such as content, courses, and meetings, a user must have Manage permission or be an Administrator.
Request URL
http://server_name/api/xml ?action=sco-move &folder-id=integer &sco-id=integer &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
folder-id |
BIGINT |
Y |
The ID of the destination folder. |
|
sco-id |
BIGINT |
Y |
The unique ID of the SCO to move. |
|
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 /> </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). |
Sample request
https://example.com/api/xml?action=sco-move&sco-id=2006744233 &folder-id=2006258748
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
See also
