Web service API

How to use PageSeeder's Web service API

create uri version

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

com.pageseeder.version.CreateVersion

Description

Create a new version

Adds a version to a uri or if the uri is a folder the uris under it.

If the URI is a folder this service will start an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
nameThe version number or name.yesstring
descriptionThe version content.nostring
labelsGeneral label values for comment (e.g. Important, Typo).nostring
notifySend notification flag, e.g. 'silent', 'normal', 'announce'.noenumsilent
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse
publicationidThe ID of the publication associated with the version.nopublicationid

Notify parameter

This parameter must be one of:

  • normal  notify based on each member's notification settings;
  • announce  will ignore members' individual notifications settings;
  • silent  no notification

 

Permission

Undocumented permissions requirements.

Response

If {uri} is valid, the output has the following format:

 <version-creation [warning="[warning]"]
                   [notify-param-ignored=true"]>
   <version id="[id]"
            name="[version name]"
            created="[date/time]">
     <author id="12" ... >
       <fullname>John Jones</fullname>
     </author>
     <description>[content of version]</description>
     <labels>[labels]</labels>
   </version>
 </version-creation>

If {uri} is invalid, the return is:

 <version-creation>
   <thread ...>...</thread>
 </version-creation>

Error Handling

CodeCause / Description
0x0201The name  is required.
0x0202The group was not found, when group is invalid.
0x0204The member was not found, when (member and url is invalid).
0x0206The group was not found, when (member and group is invalid).
0x020EThe group was not found, when (member, group and uri is invalid).

Created on , last edited on