Web service API

How to use PageSeeder's Web service API

create folder foruri

/members/{member}/groups/{group}/uris/{uri}/folders [POST]

com.pageseeder.uri.CreateFolder

Description

Creates a new folder under the specified destination.

Parameters

NameDescriptionRequiredTypeDefault value
name Name of folder to create maybe string
description Description of new folder no string
docid Folder ID no string
labels Comma separated list of folder labels no string
title Display title of new folder no string

Permission

Undocumented permissions requirements.

Response

The XML output follows this format:

<folder-creation [renamed="true" original-name="new:folder"]>
   <uri id="138614"
        scheme="https"
        host="localhost"
        port="443"
        folder="true"
        path="/ps/jb/group1/documents/new_folder"
        decodedpath="/ps/jb/group1/documents/new_folder"
        external="false"
        mediatype="folder"
        created="2013-12-19T15:14:54+11:00">
      <displaytitle>New folder</displaytitle>
   </uri>
</folder-creation> 

Error handling

CodeCause / Description
0x1201 Illegal character in filename
0x1216 Invalid destination
0x120A Invalid Document ID
0x1209 Existing Document ID
0x1211 Existing URI
0x1217 Two contradictory parameters have been specified (url and name or url and parenturl or url and parentfolder or parenturl and parentfolder)

Created on , last edited on