| Query Parameters |
|
Host:
Host for queries
| ondemand.metacarta.com |
|
API:
API to use.
| |
Query:
Optional
default value: ''
allowed values: string
usage: The GTS supports query strings as traditionally defined in
the information retrieval industry. Details of the query string
format are described in the GTS documentation. The query string
can include query operators such as 'site:<domain>'
|
|
BBox:
Optional
default value: '-180,-90,180,90'
allowed values: comma separated string of minlon,minlat,maxlon,maxlat
usage: Defines the query's geographic extent.
|
|
|
Location Finder Specific Fields
|
|
geometry:
|
|
|
GeoTagger Specific Fields
|
doc:
Optional
default value: none
allowed values: any string of text.
usage: Text to be used for GeoTagger input.
|
|
URL:
Optional
default value: none
allowed values: any web accessible URL.
usage: URL to be used as GeoTagger input.
|
|
useragent:
Optional
default value: "Mozilla/5.0 (MetaCarta Labs GeoTagger Web Service; support@metacarta.com)"
allowed values: any string of text.
usage: Text to be used as user agent for web request.
|
|
mime:
Optional
default value: "text/plain"
allowed values: any string of text.
usage: MIME Type of data. 'text/html' will turn on XPath parsing.
|
|
mingeoconfidence:
Optional
default value: 0.0
allowed values: float
usage: Minimum confidence for returned results.
|
|
Method:
Optional
default value: 'getLocationReferences'
allowed values: 'getLocationReferences', 'getDocumentReferences', 'getEnhancedLocationReferences', 'getHierarchicalLocationExtracts', 'getEnhancedLocationExtracts'
usage: Specifies the API function. Calling a particular method on
a GeoSearch instance overrides any 'action' parameter in the params
dict.
| |
|
Search Specific Fields
|
Action:
Optional
default value: 'getLocationReferences'
allowed values: 'getLocationReferences', 'getDocumentReferences',
'getMetadataKeys', 'getMetadataValues',
'getCachedDocuments'
usage: Specifies the API function. Calling a particular method on
a GeoSearch instance overrides any 'action' parameter in the params
dict.
| |
|
StartRef:
| |
MaxRefs:
Optional
default value: 40
allowed values: positive integers
usage: Limits the number of georeference returned for each grid
cell in the query. See the 'grid' parameter for more details.'
| |
Grid:
Optional
default value: 1,1
allowed values: a two integers separated by a comma
usage: The two-tuple of positive non-zero integers becomes a string
of the form """%d,%d""" % (number_of_columns,number_of_rows), which
causes the API to divide the query's geographic extent into a grid
of said dimensions and to perform a separate query for each grid
cell on the server-side. The results from each grid cell's query
are merged together and returned to the client in a single result
set. The other parameters are applied to each grid cell
individually. The 'maxrefs' parameter only limits the number of
results per grid cell, so the total number of returned results
could be as high as (number_of_rows*number_of_columns*maxrefs).
While more computationally expensive, use of this parameter can
improve the clarity of results by allowing users to see where lower
relevance results appear. In any given grid cell, it is possible
for most or all of the results between 'start' and
'start'+'maxrefs' to refer to a single location even though the
corpus contains other references to locations within that grid
cell.
| |
MinExtractedTime:
Optional
default value: '', i.e. unlimited
allowed values: integer or ''
usage: Limits returned georeferences to have extracted times more
than 'MinExtractedTime'.
| |
MaxExtractedTime:
Optional
default value: '', i.e. unlimited
allowed values: integer or ''
usage: Limits returned georeferences to have extracted times less
than 'maxtime'.
|
|
Key:
Optional
default value: empty list
allowed values: list of strings
usage: One or more key=<MetadataKey string> parameters must be
included in a request for getMetadataValues.
|
|
DocToken:
Optional
default value: empty list
allowed values: list of strings
usage: One or more docid= parameters must be included
in a request for getCachedDocuments.
|
|
Version:
Required
allowed values: '1.0.0'
usage: The requestor must specify the API version they wish to use. This JSON client sets the version=1.0.0 by default; the API requires a valid version parameter.
| 1.0.0 |
Callback:
Optional
default value: None
allowed values: string
usage: Setting a handler= parameter causes
the API to return JSON output inside of parenthesis appended to the
end of the function name. A semicolon is appended to the end of
the combined string. This allows web browsers to load the output
directly into memory using a SCRIPT element, which can be
dynamically added to the DOM. This enables in-browser aggregated
search.
|
used by JSON Explorer |
| |
Alter query parameters to update the JSON results.