Web API Home Page

 ObjectsSearch Web APIs (beta)


  Home

  OS Web APIs
  Overview
  Download
  Tutorials
  Contact Us

 

ObjectsSearch Web APIs Reference

1.  Overview

1.1 Search Requests

2. Search Request Format

2.1 Search Parameters

2.2 Query Terms

3. Search Results Format

3.1 Search Response

3.2 Result Element

 Overview

This document explains in detail the semantics of the function calls you can make using the ObjectsSearch Web APIs service. In this document, you will learn:

  • How ObjectsSearch's query syntax works.
  • How to interpret the search results information sent back by the ObjectsSearchWeb APIs service.

You may also find the following files from the ObjectsSearch Web APIs developer kit to be helpful:

  • ObjectsSearch.wsdl - WSDL description for ObjectsSearch Web APIs SOAP interface.

This is a beta document. If you have comments, find errors, or just have questions, please contact

 

1.1 Search Requests

Search requests submit a query string and a set of parameters to the ObjectsSearch Web APIs service and receive in return a set of search results.

The details of the interactions involved with search requests are covered in the Search Request Format and Search Results Format sections of this document.

 

2. Search Request Format 

2.1 Search Parameters 

Name
Description

queryParameter

 search query

startParameter

Zero-based index of the first desired result.
hitsPerPageParameter

Number of results desired per query. The maximum value per query is 10.
Note: If you do a query that doesn't have many matches, the actual number of results you get may be smaller than what you request.

2.2 Query Terms - <queryParameter> 

Please visit the link below for information on Queries.

http://www.objectssearch.com/en/help.html

 

3. Search Results Format

3.1 Search Response

Each time you issue a search request to the ObjectsSearch service, a response is returned back to you. This section describes the meanings of the values returned to you.

<resultElements> - An array of <resultElement> items. This corresponds to the actual list of search results.

<searchQuery> - This is the value of <queryParameter> for the search request.

<startIndex> - Indicates the index (1-based) of the first search result in <resultElements>.

<endIndex> - Indicates the index (1-based) of the last search result in <resultElements>.

<estimatedTotalResultsCount> - The estimated total number of results that exist for the query.

 

3.2 OS_SearchResultElement

<summary> -  Summary shows the query in context on the URL where it appears. This is formatted HTML and usually includes <B> tags within it. Note that the query term does not always appear in the summary. Note: Query terms will be in highlighted in bold in the results, and line breaks will be included for proper text wrapping.

<URL> - The URL of the search result, returned as text, with an absolute URL path.

<title> - The title of the search result, returned as HTML