Skip to main content

 Services

Web services from /about to /webhooks

uri structure

/members/{member}/groups/{group}/uris/{uri}/structure [PUT]

Description

Edit the structure of a PSML document by providing a new structure using the XML format shown in the response.

  • If the ID of an existing fragment is not in the new structure the fragment is archived.
  • If the ID of an archived fragment is in the new structure the fragment is unarchived.

The new structure must be in the enclosed entity content of the request.

Parameters

NameDescriptionRequiredTypeDefault value
lastmodifiedThe last modified date/time (ISO 8601) of the URI structure (prevents edit clashes)nodate

Permission

This service requires contributor or higher.

Response

The output has the following format:

   <document>
     <section id="title" [title="My section title for UI"]>
       [<title>My section title for content</title>]
       <fragment-ref id="1" />
       ...
     </section>
     [<toc/>]
     <section id="content" [title="My section title for UI"]>
       [<title>My section title for content</title>]
       <fragment-ref id="2" />
       ...
     </section>
     ...
   </document>

Error handling

No specific errors expected for this generator.

Created on , last edited on