Skip to main content

 Web service API

How to use PageSeeder's Web service API

get uri drafts

/groups/{group}/uris/{uri}/drafts [GET]

com.pageseeder.psml.GetDraftEdits

Description

Get the draft edits for a URI.

Parameters

NameDescriptionRequiredTypeDefault value
contentsThe draft fragment contents to include, can be none, allnoenumnone
positionThe position (instance number) of this document in the publication (requires publicationid)nointeger1
publicationWhether to do default publication auto-numbering even if no publicationid (requires transclude=true)nobooleanfalse
publicationidThe ID of the publication context for this document to return numbering (requires transclude=true)nopublicationid
transcludeWhether transclusions should be resolved (requires contents=all)nobooleanfalse

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

The output has the following format:

<drafts>
  <draft id="234"
         created="2012-03-08T12:34:00+10:00">    
    <author id="12" ... >
      <fullname>John Jones</fullname>
    </author>
    [<locator fragment="10"/>|<metadata/>]
    [<document-fragment> ... </document-fragment>]
  </draft>
  ...
</drafts>

Error Handling

No specific errors expected for this service.

Created on , last edited on