Skip to main content

 Web service API

How to use PageSeeder's Web service API

create group folder

/groups/{group}/folders/create [POST]

com.pageseeder.groupfolder.CreateGroupFolderDeprecated

Description

Create a new group folder (also known as GroupURI) with the URL specified in the request.

This URL has been deprecated in PageSeeder 5.6 and has been scheduled to be removed.

Use Service: /members/{member}/groups/{group}/groupfolders [POST] instead.

 

Parameters

NameDescriptionRequiredTypeDefault value
urlthe url of the group folder (/* suffix is added automatically)yesstring
publicif true also add to public groupnobooleanfalse

Permission

This service requires administrator.

Response

This service returns the group folder that was created as a <groupfolder> element wrapped in a <groupfolder-creation> element.

<groupfolder-creation>
  <groupfolder id="[groupuri id]"
               scheme="[scheme]"
               host="[host]"
               port="[port]"
               path="[path]"
               external="[true|false]"
               public="[true|false]"  />
</groupfolder-creation>

Error Handling

CodeCause / Description
0x1401 If the url is invalid
0x1402 If the host is unknown
0x1403 If the group folder URL already exists in group
Created on , last edited on