Version 0.3
This API is still under development and is subject to further change.
Elements starting with $ (e.g. $field) are
variable names.
{
"request" : Str,
"version" : Str,
// Navigation information about the result set:
"result" : {
"page" : Int,
"pages" : Int,
"prev_page" : Str,
"next_page" : Str,
"hits" : Int,
"hits_per_page" : Int,
"hits_from" : Int,
"hits_to" : Int,
"query_time" : Int,
},
// About the range of publication dates in the set:
"pubdate" : {
"min" : Str,
"max" : Str,
"min_year" : Int,
"max_year" : Int,
},
// Facetable fields:
"facet" : {
"lang" : [ name, value, ... ],
"media" : [ name, value, ... ],
"contributor" : [ name, value, ... ],
},
// List of matching documents (current page):
"docs" : [
{
"key" : Str,
"pkey" : Str,
"label" : Str,
"type" : Str,
"location" : Str,
"title" : [ Str, ... ],
"creator" : [ Str, ... ],
"Subject" : [ Str, ... ],
"Note" : [ Str, ... ],
}, ...
],
}
The first part of the response contains information about the search result set. These values are primarily useful for navigating through the result set.
The facet section of the response provides facet counts for selected
fields: document language, media type and contributor identifier. each
facet field provides an array of value and count pairs, indicating the
number of documents containing each value. In the following example, there
are 18 documents in Englihsh, 12 in French and 7 in Chinese within the
result set:
The docs section of the response includes an array of
documents for the current results page (corresponding to the position in
the result set described by the page, hits_from
and hits_to variables). Within each document is a table of
field-value pairs. Fields which can only contain a single value (e.g.,
key, location have string values, while fields
that could contain more than one value (e.g., title,
creator) have array values, even if there is only a single
value for that particular record.
"lang" : [ "eng", 18, "fra", 12, "zho", 7 ]