Specification of the OReFiL WebAPI

Begin a search

Comments and suggestions are welcome, please send an email to yayamamo AT cb DOT k DOT u-tokyo DOT ac DOT jp.

Interface Specifications

SOAP

Name Description Must/Optional Default Value Allowable Values
expression Query String Must - Expression that can be acceptable by IndriRunQuery
max_results Maximum Number of Result Entries Must - 1 - 1000
order Sort Order Must - `relevance` or `date`
enable_hide_unfetched Display or Hide of Status 404 URLs Must - `true` or `false`
enable_relevance_feedback Relevance Feedback Must - `true` or `false`

REST

Name Description Must/Optional Default Value Allowbale Values
query Query String Must - Expression that can be acceptable by IndriRunQuery
count Maximum Number of Result Entries Optional 100 1 - 1000
sort_by Sort Order Optional relevance `relevance` or `date`
hide_unfetched Display or Hide of Status 404 URLs Optional on `on` or `off`
feedback Relevance Feedback Optional off `on` or `off`

Response

Request / Response Sample

Here are samples of requests and their corresponding responses in SOAP and REST.

SOAP

REST