uri fragment

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

com.pageseeder.psml.GetFragment

API Support	Available since	Last updated	Output
supported	5.0500	5.9600	xml

Description

Fragment's Content

Load the fragment content of a document.

Parameters

Name	Description	Required	Type	Default value
includedraft	Whether draft content from the current member should be included.	no	boolean	`false`
newproperties	Whether new properties from the document template should be added (fragment MUST have a type or be metadata properties).	no	boolean	`false`
position	The position (instance number) of this document in the publication (requires `publicationid`).	no	integer	`1`
publicationid	The `ID` of the publication context for this document to return numbering (requires `transclude=true`).	no	publicationid
transclude	Whether transclusions should be resolved.	no	boolean	`false`

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

Code	Cause / Description
0x0101	Access forbidden, if URI was not found.
0x0102	Unable to find requested service, if put a character "@" or "," in {fragment}.
0x0202	The Group was not found.
0x0204	The Member was not found.

Created on 06 November 2012 , last edited on 11 February 2019 at 16:14