Skip to main content

 Web service API

How to use PageSeeder's Web service API

add uri fragment

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



Create a new fragment at specified location in a document.


NameDescriptionRequiredTypeDefault value
contentContent of edityesstring
afterfragmentID of the fragment to insert the fragment after (required if no section or beforefragment, overrides section and beforefragment)maybestring
beforefragmentID of the fragment to insert the fragment before (required if no section or afterfragment, overrides section)maybestring
sectionID of the section to append the fragment to, after other fragments (required if no beforefragment or afterfragment)maybestring
draftA flag to save edit as a draftnobooleanfalse
The fragment ID to use if not generatednofragment-id
fragmentprefixPrefix in front of the generated fragment IDnofragment-id
htmlFlag to specify if content is HTMLnobooleanfalse
labelsComma-separated list of edit labels valuesnostring
markdownA flag to specify if content is markdown (overrides html parameter)nobooleanfalse
noteContent for edit notes (if exists, creates a note)nostring
note-labelsComma-separated list of label values for the note (if exists, creates a note)nostring
note-titleA title for the edit notenostringEdit Note
tidyA flag to perform Tidy on HTML contentnobooleantrue
transcludeA flag to resolve transclusions when outputting resultnobooleantrue


This service requires contributor or higher.


When successful, the new fragment is returned as a <document-fragment> wrapped in a <fragment-creation> element with the following optional attributes:

  • notification-email-delayed="true" – if the edit note notification has been queued due to large number of recipients.
  • notification-email-failed="true" – if the edit note notification could not be sent.
  • unresolved-xrefs="true" – if their are unresolved cross references in the fragment.


<fragment-creation notification-email-failed="true">
    <locator id="325"
        <note id="6342"
          <content>Fixed typographical error.</content>
    <fragment id="example">
      <para>This is the fragment content</para>

Error Handling

CodeCause / Description
0x120BError processing XRefs
0x120CError creating fragment
0x120DContent validation error
0x122CThe fragment already exists
0x122DThe fragment is invalid
0x6302Failed to create new comment
Created on , last edited on