Contentbox

From n² wiki

Jump to: navigation, search

Nearby: Platform API

URI Pattern
http://api.talis.com/stores/{store}/items
Allowed Methods
GET,POST

This URI represents a store's Contentbox, a list of content items that are managed by the store.

[edit] GET

GETs to the contentbox require the basic search capability.

If no parameters are supplied, this service responds with an HTML form to assist creating the correct set of parameters.

Contentbox search responses are RSS 1.0 documents

Optional Parameters

  • query - the query expression used to search the content box. Supports any expression in the Text Search Syntax
  • max - The maximum number of results to return in the results. If this parameter is not supplied it defaults to a value of 10
  • offset - The number of results to skip before listing the results. If this parameter is not supplied it defaults to a value of 0. When combined with the max parameter this can be used to implement paging of results.
  • xsl - the URI of an XSLT stylesheet that should be applied to the search results
  • content-type - a media type that should be used in the Content-Type header of the response when a stylesheet has been applied to the results.
  • sort - a comma-separated list of field names by which the results should be ordered. Append :d to a field name to sort descending.

[edit] POST

POSTs to the contentbox require the full update capability.

Content POSTed to this URI is added as a new item to the Contentbox. A successful response will be indicated with a 201 Created HTTP status code or a 202 Accepted code. The URI assigned to the content will be returned in a Location header.

Retrieved from "http://n2.talis.com/wiki/Contentbox"
Personal tools