Show Menu
TOPICS×

createFolder

Creates a folder.
The new folder is subordinate to the Images folder, even if you specify a / to indicate the root of the company.
Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
The user must have read/write access to the parent folder.

Parameters

Input (createFolder)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The Handle to the company
* folderPath *
xsd:string
Yes
The root folder used to retrieve folders and all subfolders to the leaf level. If excluded, the company root is used.
Output (createFolderParam)
Name
Type
Required
Description
* folderHandle *
xsd:string
Yes
Handle of the new folder.

Examples

This sample code creates a folder at the root of a company. The response returns the handle of the newly created folder.
Request
<ns1:createFolderParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:folderPath>/SpinSets</ns1:folderPath>
</ns1:createFolderParam>

Response
<ns1:createFolderReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <folderHandle xmlns="http://www.scene7.com/IpsApi/xsd">MyCompany/SpinSets/</folderHandle>
</ns1:createFolderReturn>