Common Request ParametersThis is a featured page

The following are a common set of request parameters that may be supplied to various service calls.

Notable among these are key and ns, which must be provided with every request. The values for these two parameters are determined during application setup.


Required Parameters:
key
The developer key. This value is provided by Wetpaint during initial developer registration.
ns
The content namespace. This value is provided by Wetpaint during initial developer registration.

Optional Parameters:

output
Output type. May optionally be specified as api to enable structured XML output. If this parameter is not provided, service calls typically return HTML for use by server-side includes or AJAX calls; the exact default output may vary on a call-by-call basis.
ticket
The ticket assigned to the current logged-in user. This should be provided for all service calls made on behalf of a user. Server-side includes and ajax calls made on behalf of an anonymous end user should omit this parameter.
offset
For service calls returning a collection of results, this is the index of the first result to return, starting from 0. Defaults to 0 for such requests, and is ignored if the call doesn't return a collection.
maxResults
For service calls returning a collection of results, this is the maximum number of results to return. Defaults to 20 for such requests,and is ignored if the call doesn't return a collection.



bennyflint
bennyflint
Latest page update: made by bennyflint , Oct 8 2008, 1:55 PM EDT (about this update About This Update bennyflint Edited by bennyflint

1 word deleted

view changes

- complete history)
More Info: links to this page
There are no threads for this page.  Be the first to start a new thread.

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.)