hiscentral Web Service

hiscentral

Click here for a complete list of operations.

GetSeriesMetadataCountOrData

Provides information about metadata stored in the catalog.Tycally used to search the catalog.
It can return

1.The count of timeseries that match the provided parameters.
2.the statistics for the distribution of all facets for timeseries that match the provided parameters.e.g how many timeseries have the datatype 'average', or the keyword 'precipitation'.
3.the complete set of all metadata records for timeseries that match the provided parameters.

The return can be defined by providing the appropriate parameters in the request.The return of this request can not exceed 25.000 timeseries.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
getData:
getFacetOnCV:
xmin:
xmax:
ymin:
ymax:
sampleMedium:
dataType:
valueType:
generalCategory:
conceptKeyword:
networkIDs:
beginDate:
endDate:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/hiscentral.asmx HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://hiscentral.cuahsi.org/20100205/GetSeriesMetadataCountOrData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSeriesMetadataCountOrData xmlns="http://hiscentral.cuahsi.org/20100205/">
      <getData>boolean</getData>
      <getFacetOnCV>boolean</getFacetOnCV>
      <xmin>double</xmin>
      <xmax>double</xmax>
      <ymin>double</ymin>
      <ymax>double</ymax>
      <sampleMedium>string</sampleMedium>
      <dataType>string</dataType>
      <valueType>string</valueType>
      <generalCategory>string</generalCategory>
      <conceptKeyword>string</conceptKeyword>
      <networkIDs>string</networkIDs>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
    </GetSeriesMetadataCountOrData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSeriesMetadataCountOrDataResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <GetSeriesMetadataCountOrDataResult>
        <nseries>long</nseries>
        <message>string</message>
        <facet_fields>
          <FacetField>
            <name>string</name>
            <itemCount>long</itemCount>
            <items xsi:nil="true" />
          </FacetField>
          <FacetField>
            <name>string</name>
            <itemCount>long</itemCount>
            <items xsi:nil="true" />
          </FacetField>
        </facet_fields>
        <series>
          <SeriesRecordFull2>
            <ServCode>string</ServCode>
            <ServURL>string</ServURL>
            <location>string</location>
            <VarCode>string</VarCode>
            <VarName>string</VarName>
            <beginDate>string</beginDate>
            <endDate>string</endDate>
            <authtoken>string</authtoken>
            <ValueCount>string</ValueCount>
            <Sitename>string</Sitename>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <datatype>string</datatype>
            <valuetype>string</valuetype>
            <samplemedium>string</samplemedium>
            <timeunits>string</timeunits>
            <conceptKeyword>string</conceptKeyword>
            <genCategory>string</genCategory>
            <TimeSupport>string</TimeSupport>
            <SeriesCode>string</SeriesCode>
            <QCLID>string</QCLID>
            <QCLDesc>string</QCLDesc>
            <Organization>string</Organization>
            <TimeUnitAbbrev>string</TimeUnitAbbrev>
            <IsRegular>string</IsRegular>
            <Speciation>string</Speciation>
            <SourceOrg>string</SourceOrg>
            <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
            <SourceId>string</SourceId>
            <SourceDesc>string</SourceDesc>
            <MethodId>string</MethodId>
            <MethodDesc>string</MethodDesc>
          </SeriesRecordFull2>
          <SeriesRecordFull2>
            <ServCode>string</ServCode>
            <ServURL>string</ServURL>
            <location>string</location>
            <VarCode>string</VarCode>
            <VarName>string</VarName>
            <beginDate>string</beginDate>
            <endDate>string</endDate>
            <authtoken>string</authtoken>
            <ValueCount>string</ValueCount>
            <Sitename>string</Sitename>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <datatype>string</datatype>
            <valuetype>string</valuetype>
            <samplemedium>string</samplemedium>
            <timeunits>string</timeunits>
            <conceptKeyword>string</conceptKeyword>
            <genCategory>string</genCategory>
            <TimeSupport>string</TimeSupport>
            <SeriesCode>string</SeriesCode>
            <QCLID>string</QCLID>
            <QCLDesc>string</QCLDesc>
            <Organization>string</Organization>
            <TimeUnitAbbrev>string</TimeUnitAbbrev>
            <IsRegular>string</IsRegular>
            <Speciation>string</Speciation>
            <SourceOrg>string</SourceOrg>
            <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
            <SourceId>string</SourceId>
            <SourceDesc>string</SourceDesc>
            <MethodId>string</MethodId>
            <MethodDesc>string</MethodDesc>
          </SeriesRecordFull2>
        </series>
      </GetSeriesMetadataCountOrDataResult>
    </GetSeriesMetadataCountOrDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/hiscentral.asmx HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSeriesMetadataCountOrData xmlns="http://hiscentral.cuahsi.org/20100205/">
      <getData>boolean</getData>
      <getFacetOnCV>boolean</getFacetOnCV>
      <xmin>double</xmin>
      <xmax>double</xmax>
      <ymin>double</ymin>
      <ymax>double</ymax>
      <sampleMedium>string</sampleMedium>
      <dataType>string</dataType>
      <valueType>string</valueType>
      <generalCategory>string</generalCategory>
      <conceptKeyword>string</conceptKeyword>
      <networkIDs>string</networkIDs>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
    </GetSeriesMetadataCountOrData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSeriesMetadataCountOrDataResponse xmlns="http://hiscentral.cuahsi.org/20100205/">
      <GetSeriesMetadataCountOrDataResult>
        <nseries>long</nseries>
        <message>string</message>
        <facet_fields>
          <FacetField>
            <name>string</name>
            <itemCount>long</itemCount>
            <items xsi:nil="true" />
          </FacetField>
          <FacetField>
            <name>string</name>
            <itemCount>long</itemCount>
            <items xsi:nil="true" />
          </FacetField>
        </facet_fields>
        <series>
          <SeriesRecordFull2>
            <ServCode>string</ServCode>
            <ServURL>string</ServURL>
            <location>string</location>
            <VarCode>string</VarCode>
            <VarName>string</VarName>
            <beginDate>string</beginDate>
            <endDate>string</endDate>
            <authtoken>string</authtoken>
            <ValueCount>string</ValueCount>
            <Sitename>string</Sitename>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <datatype>string</datatype>
            <valuetype>string</valuetype>
            <samplemedium>string</samplemedium>
            <timeunits>string</timeunits>
            <conceptKeyword>string</conceptKeyword>
            <genCategory>string</genCategory>
            <TimeSupport>string</TimeSupport>
            <SeriesCode>string</SeriesCode>
            <QCLID>string</QCLID>
            <QCLDesc>string</QCLDesc>
            <Organization>string</Organization>
            <TimeUnitAbbrev>string</TimeUnitAbbrev>
            <IsRegular>string</IsRegular>
            <Speciation>string</Speciation>
            <SourceOrg>string</SourceOrg>
            <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
            <SourceId>string</SourceId>
            <SourceDesc>string</SourceDesc>
            <MethodId>string</MethodId>
            <MethodDesc>string</MethodDesc>
          </SeriesRecordFull2>
          <SeriesRecordFull2>
            <ServCode>string</ServCode>
            <ServURL>string</ServURL>
            <location>string</location>
            <VarCode>string</VarCode>
            <VarName>string</VarName>
            <beginDate>string</beginDate>
            <endDate>string</endDate>
            <authtoken>string</authtoken>
            <ValueCount>string</ValueCount>
            <Sitename>string</Sitename>
            <latitude>string</latitude>
            <longitude>string</longitude>
            <datatype>string</datatype>
            <valuetype>string</valuetype>
            <samplemedium>string</samplemedium>
            <timeunits>string</timeunits>
            <conceptKeyword>string</conceptKeyword>
            <genCategory>string</genCategory>
            <TimeSupport>string</TimeSupport>
            <SeriesCode>string</SeriesCode>
            <QCLID>string</QCLID>
            <QCLDesc>string</QCLDesc>
            <Organization>string</Organization>
            <TimeUnitAbbrev>string</TimeUnitAbbrev>
            <IsRegular>string</IsRegular>
            <Speciation>string</Speciation>
            <SourceOrg>string</SourceOrg>
            <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
            <SourceId>string</SourceId>
            <SourceDesc>string</SourceDesc>
            <MethodId>string</MethodId>
            <MethodDesc>string</MethodDesc>
          </SeriesRecordFull2>
        </series>
      </GetSeriesMetadataCountOrDataResult>
    </GetSeriesMetadataCountOrDataResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /webservices/hiscentral.asmx/GetSeriesMetadataCountOrData?getData=string&getFacetOnCV=string&xmin=string&xmax=string&ymin=string&ymax=string&sampleMedium=string&dataType=string&valueType=string&generalCategory=string&conceptKeyword=string&networkIDs=string&beginDate=string&endDate=string HTTP/1.1
Host: hiscentral.cuahsi.org

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetSeriesCountOrData xmlns="http://hiscentral.cuahsi.org/20100205/">
  <nseries>long</nseries>
  <message>string</message>
  <facet_fields>
    <FacetField>
      <name>string</name>
      <itemCount>long</itemCount>
      <items>
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </items>
    </FacetField>
    <FacetField>
      <name>string</name>
      <itemCount>long</itemCount>
      <items>
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </items>
    </FacetField>
  </facet_fields>
  <series>
    <SeriesRecordFull2>
      <ServCode>string</ServCode>
      <ServURL>string</ServURL>
      <location>string</location>
      <VarCode>string</VarCode>
      <VarName>string</VarName>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
      <authtoken>string</authtoken>
      <ValueCount>string</ValueCount>
      <Sitename>string</Sitename>
      <latitude>string</latitude>
      <longitude>string</longitude>
      <datatype>string</datatype>
      <valuetype>string</valuetype>
      <samplemedium>string</samplemedium>
      <timeunits>string</timeunits>
      <conceptKeyword>string</conceptKeyword>
      <genCategory>string</genCategory>
      <TimeSupport>string</TimeSupport>
      <SeriesCode>string</SeriesCode>
      <QCLID>string</QCLID>
      <QCLDesc>string</QCLDesc>
      <Organization>string</Organization>
      <TimeUnitAbbrev>string</TimeUnitAbbrev>
      <IsRegular>string</IsRegular>
      <Speciation>string</Speciation>
      <SourceOrg>string</SourceOrg>
      <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
      <SourceId>string</SourceId>
      <SourceDesc>string</SourceDesc>
      <MethodId>string</MethodId>
      <MethodDesc>string</MethodDesc>
    </SeriesRecordFull2>
    <SeriesRecordFull2>
      <ServCode>string</ServCode>
      <ServURL>string</ServURL>
      <location>string</location>
      <VarCode>string</VarCode>
      <VarName>string</VarName>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
      <authtoken>string</authtoken>
      <ValueCount>string</ValueCount>
      <Sitename>string</Sitename>
      <latitude>string</latitude>
      <longitude>string</longitude>
      <datatype>string</datatype>
      <valuetype>string</valuetype>
      <samplemedium>string</samplemedium>
      <timeunits>string</timeunits>
      <conceptKeyword>string</conceptKeyword>
      <genCategory>string</genCategory>
      <TimeSupport>string</TimeSupport>
      <SeriesCode>string</SeriesCode>
      <QCLID>string</QCLID>
      <QCLDesc>string</QCLDesc>
      <Organization>string</Organization>
      <TimeUnitAbbrev>string</TimeUnitAbbrev>
      <IsRegular>string</IsRegular>
      <Speciation>string</Speciation>
      <SourceOrg>string</SourceOrg>
      <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
      <SourceId>string</SourceId>
      <SourceDesc>string</SourceDesc>
      <MethodId>string</MethodId>
      <MethodDesc>string</MethodDesc>
    </SeriesRecordFull2>
  </series>
</GetSeriesCountOrData>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/hiscentral.asmx/GetSeriesMetadataCountOrData HTTP/1.1
Host: hiscentral.cuahsi.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

getData=string&getFacetOnCV=string&xmin=string&xmax=string&ymin=string&ymax=string&sampleMedium=string&dataType=string&valueType=string&generalCategory=string&conceptKeyword=string&networkIDs=string&beginDate=string&endDate=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetSeriesCountOrData xmlns="http://hiscentral.cuahsi.org/20100205/">
  <nseries>long</nseries>
  <message>string</message>
  <facet_fields>
    <FacetField>
      <name>string</name>
      <itemCount>long</itemCount>
      <items>
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </items>
    </FacetField>
    <FacetField>
      <name>string</name>
      <itemCount>long</itemCount>
      <items>
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <item d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </items>
    </FacetField>
  </facet_fields>
  <series>
    <SeriesRecordFull2>
      <ServCode>string</ServCode>
      <ServURL>string</ServURL>
      <location>string</location>
      <VarCode>string</VarCode>
      <VarName>string</VarName>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
      <authtoken>string</authtoken>
      <ValueCount>string</ValueCount>
      <Sitename>string</Sitename>
      <latitude>string</latitude>
      <longitude>string</longitude>
      <datatype>string</datatype>
      <valuetype>string</valuetype>
      <samplemedium>string</samplemedium>
      <timeunits>string</timeunits>
      <conceptKeyword>string</conceptKeyword>
      <genCategory>string</genCategory>
      <TimeSupport>string</TimeSupport>
      <SeriesCode>string</SeriesCode>
      <QCLID>string</QCLID>
      <QCLDesc>string</QCLDesc>
      <Organization>string</Organization>
      <TimeUnitAbbrev>string</TimeUnitAbbrev>
      <IsRegular>string</IsRegular>
      <Speciation>string</Speciation>
      <SourceOrg>string</SourceOrg>
      <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
      <SourceId>string</SourceId>
      <SourceDesc>string</SourceDesc>
      <MethodId>string</MethodId>
      <MethodDesc>string</MethodDesc>
    </SeriesRecordFull2>
    <SeriesRecordFull2>
      <ServCode>string</ServCode>
      <ServURL>string</ServURL>
      <location>string</location>
      <VarCode>string</VarCode>
      <VarName>string</VarName>
      <beginDate>string</beginDate>
      <endDate>string</endDate>
      <authtoken>string</authtoken>
      <ValueCount>string</ValueCount>
      <Sitename>string</Sitename>
      <latitude>string</latitude>
      <longitude>string</longitude>
      <datatype>string</datatype>
      <valuetype>string</valuetype>
      <samplemedium>string</samplemedium>
      <timeunits>string</timeunits>
      <conceptKeyword>string</conceptKeyword>
      <genCategory>string</genCategory>
      <TimeSupport>string</TimeSupport>
      <SeriesCode>string</SeriesCode>
      <QCLID>string</QCLID>
      <QCLDesc>string</QCLDesc>
      <Organization>string</Organization>
      <TimeUnitAbbrev>string</TimeUnitAbbrev>
      <IsRegular>string</IsRegular>
      <Speciation>string</Speciation>
      <SourceOrg>string</SourceOrg>
      <VariableUnitsAbbrev>string</VariableUnitsAbbrev>
      <SourceId>string</SourceId>
      <SourceDesc>string</SourceDesc>
      <MethodId>string</MethodId>
      <MethodDesc>string</MethodDesc>
    </SeriesRecordFull2>
  </series>
</GetSeriesCountOrData>