Web service API

How to use PageSeeder's Web service API

create group folder

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

com.pageseeder.groupfolder.CreateGroupFolder

This service is deprecated since version 5.7900

Description

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

Deprecation warning!

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

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

 

Parameters

NameDescriptionRequiredTypeDefault value
url the url of the group folder (/* suffix will be added automatically) yes string
public if true also add to public group no boolean false

Permission

Only Administrators can invoke this service.

Response

This service return 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