CellService.getNavigationThis is a featured page


HTTP MethodURI
Returns
GET/CellService/getNavigation.doThe navigation structure for the specified cell.

Overview: Retrieves the navigation structure for the given cell. The default output for this request is a series of nested HTML unordered lists (UL's), but the HTML is probably NOT suitable for a server-side include.

The preferred way to use this request is to specify output=api on the query string. The api output format returns an xml document containing a hierarchy of cell elements that represent the requested cell's navigation structure.

The returned hierarchy starts with the requested cell's ancestral root cell, and contains all cells down to the requested cell, the requested cell itself, the cell's siblings, and the cell's immediate children. It also includes child counts for all cells ( the counts can be useful for generating custom navigation widgets, especially ones that use disclosure arrows ). The maximum number of cells that can returned in the response are 1000.
Common Parameters
plus...

Required Parameters:
output=api
Inform the service that you would like an XML response.

cell.cellId
The cell whose navigation structure to find.


Example Request ( required parameters in red ):

http://wapi.wetpaint.com/CellService/getNavigation.do
?key=yourissueddeveloperkey
&ns=yourassignednamespace
&cell.cellId=Real+Fame
&output=api

Example Response
  • requested cell's element = red
  • requested cell's children = blue
  • requested cell's siblings = orange
  • requested cell's ancestors up to root cell = purple

<response>
<cell>
<cellId>All About LeBron James</cellId>
<children total="7">
<cell>
<cellId>LeBron Bio</cellId>
<children total="3">
<cell>
<cellId>Real Fame</cellId>
<children total="3">
<cell>
<cellId>Blowing Up</cellId>
<children total="0" />
</cell>
<cell>
<cellId>Big Time</cellId>
<children total="2" />
</cell>
<cell>
<cellId>Fifteen Minutes</cellId>
<children total="1" />
</cell>
</children>
</cell>
<cell>
<cellId>Fan Q & A</cellId>
<children total="3" />
</cell>
<cell>
<cellId>Photo Gallery</cellId>
<children total="0" />
</cell>
</children>
</cell>
</children>
</cell>
</response>







superwomyn
superwomyn 		Latest page update: made by superwomyn , Nov 6 2008, 7:01 PM EST (about this update About This Update superwomyn Edited by superwomyn

2 words added

view changes
- complete history)
Keyword tags: CellService
More Info: links to this page

Threads for this page

Started By Thread Subject Replies Last Post
evolanding Cell Navigation 4 Jun 11 2008, 7:54 PM EDT by kevin_wetpaint
Thread started: Jun 11 2008, 6:57 PM EDT  Watch
In the example above, the given cell id is presented as the first child of its parent node.

Will this always be the case? Or are the children presented in some fashion which could result in the target node being in a position other than the first child position?
Do you find this valuable?    
Keyword tags: CellService
Show Last Reply
cpatni Is there a way to way to get the entire tree eagerly 3 Jun 2 2008, 4:25 PM EDT by ryan_wetpaint
Thread started: May 31 2008, 4:40 AM EDT  Watch
For SEO reasons, we want to have the entire navigation tree markup. Is there a way to do that or can be added?
Do you find this valuable?    
Keyword tags: CellService
Show Last Reply
Showing 2 of 2 threads for this page

Related Content

  (what's this?Related ContentThanks to keyword tags, links to related pages and threads are added to the bottom of your pages. Up to 15 links are shown, determined by matching tags and by how recently the content was updated; keeping the most current at the top. Share your feedback on Wetpaint Central.)
CellService.getCell CellService.getCellWithChildren CellService
CellService.getCellChildren CellService.getCellContent Cell Navigation
Tags are not returned by this call Is there a way to way to get the entire tree eagerly