Web service API

How to use PageSeeder's Web service API

uri fragment

/members/{member}/groups/{group}/uris/{uri}/fragments/{+fragment} [GET]

com.pageseeder.psml.GetFragment

Description

Fragment's Content

Load the fragment content of a document.

Parameters

NameDescriptionRequiredTypeDefault value
includedraftWhether draft content from the current member should be included.nobooleanfalse
newpropertiesWhether new properties from the document template should be added (fragment MUST have a type or be metadata properties).nobooleanfalse
positionThe position (instance number) of this document in the publication (requires publicationid).nointeger1
publicationidThe ID of the publication context for this document to return numbering (requires transclude=true).nopublicationid
transcludeWhether transclusions should be resolved.nobooleanfalse

Permission

Undocumented permissions requirements.

Response

When successful, the fragment is returned as a <document-fragment> element.

Example:

  <document-fragment>
    <locator                            id="325" 
                              fragment="example" 
                                   editid="6340" 
                  modified="2015-03-24T13:21:57">
       <notes>
           <note                   id="6342" 
              modified="2015-03-24T13:21:57" 
                          title="Typography">
             <content>
                Fixed typographical error.</content>
           </note>
       </notes>
    </locator>

    <fragment   id="example">
      <para>
         This is the fragment content</para>
    </fragment>
  </document-fragment>

Error Handling

CodeCause / Description
0x0101Access forbidden, if URI was not found.
0x0102Unable to find requested service, if  put a character "@" or "," in {fragment}.
0x0202The Group was not found.
0x0204The Member was not found.

Created on , last edited on