OpenSearch

Query Specification

Each parameter that comprises the query is as follows.
No.ParameterRequired/OptionalDescription
1queryRequiredTo specify the free word to search.
2GranuleOptional(*1)To specify the resource type of 'Granule' as the search target.
[usage] Granule=granule
3NumericalDataOptional(*1)To specify the resource type of 'NumericalData' as the search target.
[usage] NumericalData=numericaldata
4DisplayDataOptional(*1)To specify the resource type of 'DisplayData' as the search target.
[usage] DisplayData=displaydata
5InstrumentOptional(*1)To specify the resource type of 'Instrument' as the search target.
[usage] Instrument=instrument
6ObservatoryOptional(*1)To specify the resource type of 'Observatory' as the search target.
[usage] Observatory=observatory
7PersonOptional(*1)To specify the resource type of 'Person' as the search target.
[usage] Person=person
8CatalogOptional(*1)To specify the resource type of 'Catalog' as the search target.
[usage] Catalog=catalog
9RepositoryOptional(*1)To specify the resource type of 'Repository' as the search target.
[usage] Repository=repository
10DocumentOptional(*1)To specify the resource type of 'Document' as the search target.
[usage] Document=document
11RegistoryOptional(*1)To specify the resource type of 'Registory' as the search target.
[usage] Registory=registory
12ServiceOptional(*1)To specify the resource type of 'Service' as the search target.
[usage] Service=service
13AnnotationOptional(*1)To specify the resource type of 'Annotation' as the search target.
[usage] Annotation=annotation
14tsOptionalTo specify the start time of the observation. Usage is same as the Web interface.
15teOptionalTo specify the end time of the observation. Usage is same as the Web interface.
16tzOptionalTo specify timezone, UTC or JST. UTC is chosen when not specifying.
17nlatOptionalTo specify the nothernmost end in geographic latitude. (degree)
18slatOptionalTo specify the southernmost end in geographic latitude. (degree)
19elonOptionalTo specify the easternmost end in geographic longitude. (degree)
20wlonOptionalTo specify the westernmost end in geographic longitude. (dgree)
21search_objOptionalTo specify the category of search target.
[usage for earth's upper atomospheric data] search_obj=earth
[usage for solar image data] search_obj=sun
A default is for the both categories.
22regionOptionalTo specify the region category of solar image data (FullDisk/PartialRegion). This parameter is valid only when "search_obj" is set to "sun" (search_obj=sun).
[usage] region=FullDisk
[usage] region=PartialRegion
A default is for the both types.
23rppOptionalTo specify the number of records per a query. A default is 10.
24startOptionalTo specify the head of the metadata records. A default is 0.
25sort_byOptionalTo specify the sort target.
0: Relevance(The registration date of the metadata),
1: Granule StartDate,
2: ResourceType
A default is 0.
26orderOptionalTo specify the order of sorting, ASC or DESC. Basically, it is used in combination with sort_by parameter. A default is DESC.

Output Specification

The response format is ATOM1.0. OpenSearch itself supports RSS and HTML responses but we have never checked the action.
No. Tag name Num-
ber of elem-
ents
(N>0)
Description Remarks
1st Layer 2nd Layer 3rd Layer 4th Layer Attribute
1 xml 1 XML declaration <?xml version="1.0" encoding="UTF-8"?>
2 feed 1 Root Element
xmlns 1 "http://www.w3.org/2005/Atom"
xmlns:dc 1 "http://purl.org/dc/elements/1.1/"
xmlns:opensearch 1 "http://a9.com/-/spec/opensearch/1.1/"
3 title 1 Title of the field "IUGONET Metadata DB"
4 link 0..N Link to the field
href 1 Link URI to the field "http://search.iugonet.org/iugonet"
rel 0..1 Link URI Relation "alternate"
5 subtitle 0..1 Subtitle of the field
6 id 1 Identifier "http://search.iugonet.org/search"
7 updated 1 Update date The updated date on server side.
(Equal to No.8 dc:date element)
8 dc:date 1 search date The date to search
[usage] [YYYY-MM-DDTHH:NN:SSZ]
9 opensearch:itemsPerPage 1 Number of records. Number of records by 1 response
(Equal to the value of rpp parameter of query)
10 opensearch:totalResults 1 Total records The total records of the searched metadata.
11 opensearch:startIndex 1 head of metadata records Head of searched metadata records location.
(Equals to start parameter of query)
12 opensearch:Query 1 Query
role 1 Query role "request"
searchTerms 0..1 Query Query strings
startPage 0..1 Page number Current page number
13 entry 0..N Field to store the search results For a metadata, a <entry>...</entry> is consists.
14 title 1 ResourceID ResourceID of the metadata
15 link 0..N The field to store metadata URI
href 1 Metadata URI URI to specify the metadata location
rel 0..1 Link URI Relation "alternate"
16 author N Field for storing author information
17 name 1 Author (Blank)
18 id 1 Metadata URI URI to specify the metadata location
(equal to the href attribute of the link element)
19 updated 1 The date on which metadata was registrated. The date on which metadata was registrated on the metadata DB
[usage] [YYYY-MM-DDTHH:NN:SSZ]
20 published 0..1 The date on which metadata was opened to the public. The date on which metadata was opened to the public on the web.
[usage] [YYYY-MM-DDTHH:NN:SSZ]
21 dc:date 1 The date on which metadata created The date on which metadata was created
[usage] [YYYY-MM-DDTHH:NN:SSZ]
22 dc:identifier 1 Observational data URI URI to point the obsevational data location
23 dc:source 1 Metadata file URI URI to specify the location of metadata files
24 Spase (omission) (omission) 1 Body of metadata Metadata XML is returned as <Spase>~</Spase>
For the hierarchical structure, please refer to the XML Schema file in the IUGONET web page