Get place statistics Retrieve or download the place statistics data in an interval or the latest one day statistics data. URL endpoint Perform a GET operation on the following URL: URL
Description
statisticsplace{placeid}feed
Get place statistics data Authentication This ...

This document describes the interface for application development against the Lotus Quickr Places/Templates directory. The primary goal is to provide an easy to use programming interface for third party application developers to use to incorporate browsing, searching, filtering and type-ahead services over Places/Templates in their environment.

Description

This document describes the interface for application development against the Lotus Quickr Places/Templates catalog. The primary goal is to provide an easy to use programming interface for third party application developers to use to incorporate browsing & discovery of Lotus Quickr Places/Templates in their environment. The services include:
* Browsing & searching public and private places.
* Browsing & searching templates.
* Browsing popular tags associated with places.
* Type-ahead completions for place/template titles, tags and place owners.

The Places/Templates interface is based on the REST architecture style. Thus, third party applications only need to construct and send HTTP requests to the backend services. The interface is a synchronous call. The order of the parameters in the requests do not matter. The parameter names are case-sensitive and must be entered in the documented format. Any unknown or unsupported parameters submitted as part of a request are ignored.

URL Formats

The request is a standard HTTP GET command. When the request is GET, the URL is formed by combining the server's host name, port and path as well as a collection of name-value pairs (input parameters) separated by & characters.

URL Parameters and Headers

Browse/Search Requests Parameters and Headers

Places/Templates textual metadata will be presented in the supplied locale like title and description, if available

Server locale

See ISO-639 and ISO-3166 for valid values, e.g. "en_US"

query

Search query

Optional

Value must be URL-escaped if in GET request

queryLang

Language of the query string

Server locale

See ISO-639 and ISO-3166 for valid values, e.g. "en_US"

format

Format of the message body in server response

ATOM

Supported values: ATOM & XML, which result in the same output, but different HTTP response header Content-type value

start

Offset to first result to return in results

0

If specified value is negative, the value will be defaulted to 0; if the specified value is greater than the number of results, no results will be returned.

results

Number of results desired for a single request

10

Min value is 0 (when negative values are passed, the default value will be used instead)

sortKey

The key which controls the sorting order of the search results

Optional

A valid value for this parameter is one of "update_date", "title". If not provided and "query" parameter is provided, then the results are sorted by relevance.

sortOrder

Determines the order by which the results are sorted: ascending or descending

desc

The only valid values are "asc" or "desc"

Below is listed some HTTP Header parameters that are supported parameters:
* Accept-Encoding - gzip compression should be supported as requested by the client (e.g. via the Accept-Encoding: gzip HTTP request header)
* Accept-Language - If the "locale" is missing, determine the best matching representation based on Accept-Language

Completion (Type-Ahead) Requests Parameters

Name

Description

Required parameter / Default Value

Comments

prefix

The user input for which completions are required

Required

Example: "tes"

limit

The number of desired completions

10

Min value is 0

locale

Identifies the user locale, which might affect the available completions.

default server locale

If not supplied, the "accept-language" request header will be used to detect locale. If that isn't present either, the default server locale will be used.

Tags Requests Parameters

Name

Description

Required parameter / Default Value

Comments

limit

The number of desired tags

30

Min value is 0

sortKey

The key which controls the sorting order of the search results

weight

Valid values are "weight" and "name"

sortOrder

Determines the order by which the results are sorted: ascending or descending

desc

Valid values are "desc" and "asc"

locale

Identifies the user locale, which may affect the order of tags, when sorting by name.

Error Response

The error responses are standard HTTP error response messages. Errors are being mapped to the appropriate HTTP response codes. In addition, a human readable text error message is appended to the HTTP response while matching the requested language. The HTTP response header Content-type value will be 'text/html'.

The services for place creation and browsing are documented in the Portal infocenter here: http://publib.boulder.ibm.com/infocenter/wpdoc/v6r1/topic/com.ibm.wp.ent.doc_v615/caitai/i_c_caitai_rest_svcs_over.html

Steve Wubbleu commented on Sep 27, 2010

Places and Templates Catalog Services

Are there similar API calls for creating places as well as browsing them ? Has anyone got any examples ?

Copy and paste this wiki markup to link to this
article from another article in this wiki.