Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 5 Next »

/names/search

Returns a list of search results and faceting details for a query on names.

Parameters

 

querySearch string using the Search Query Syntax
filterAdditional filter to provide faceting of the results
skipNumber of records to skip when returning the results
takeThe number of records to return
orderby

Enables sorting of the results using the syntax:

fieldname [ASC|DESC]

Example Response

http://data.nzor.org.nz/names/search?query=lic*

Xml

<?xml version="1.0" encoding="utf-8"?>
<NameSearchResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Query>FullName:lic*</Query>
  <FilterQueries/>
  <SearchTime>136</SearchTime>
  <TotalCount>263</TotalCount>
  <StartRowIndex>1</StartRowIndex>
  <EndRowIndex>10</EndRowIndex>
  <MatchingTerms>
    <MatchingTerm>
      <FieldName>FullName</FieldName>
      <Text>licarsisalis</Text>
      <HitCount>1</HitCount>
    </MatchingTerm>
    <MatchingTerm>
      <FieldName>FullName</FieldName>
      <Text>lice</Text>
      <HitCount>2</HitCount>
    </MatchingTerm>
    
    ...
  
    <MatchingTerm>
      <FieldName>FullName</FieldName>
      <Text>licuala</Text>
      <HitCount>1</HitCount>
    </MatchingTerm>
  </MatchingTerms>
  <FilterFields>
    <FilterField>
      <FieldName>TaxonRankName</FieldName>
      <DisplayName>Taxon Rank</DisplayName>
      <FilterTerms>
        <FilterTerm>
          <Text>class</Text>
          <HitCount>1</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>family</Text>
          <HitCount>8</HitCount>
        </FilterTerm>
       
        ...
  
        <FilterTerm>
          <Text>variety</Text>
          <HitCount>3</HitCount>
        </FilterTerm>
      </FilterTerms>
    </FilterField>
    <FilterField>
      <FieldName>GoverningCode</FieldName>
      <DisplayName>Governing Code</DisplayName>
      <FilterTerms>
        <FilterTerm>
          <Text>icbn</Text>
          <HitCount>233</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>icnb</Text>
          <HitCount>1</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>iczn</Text>
          <HitCount>25</HitCount>
        </FilterTerm>
      </FilterTerms>
    </FilterField>
    <FilterField>
      <FieldName>NameStatus</FieldName>
      <DisplayName>Name Status</DisplayName>
      <FilterTerms>
        <FilterTerm>
          <Text>current</Text>
          <HitCount>102</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>synonym</Text>
          <HitCount>140</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>unknown</Text>
          <HitCount>21</HitCount>
        </FilterTerm>
      </FilterTerms>
    </FilterField>
    <FilterField>
      <FieldName>NameClassName</FieldName>
      <DisplayName>Name Class</DisplayName>
      <FilterTerms>
        <FilterTerm>
          <Text>scientific</Text>
          <HitCount>259</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>vernacular</Text>
          <HitCount>4</HitCount>
        </FilterTerm>
      </FilterTerms>
    </FilterField>
    <FilterField>
      <FieldName>ProviderCode</FieldName>
      <DisplayName>Provider</DisplayName>
      <FilterTerms>
        <FilterTerm>
          <Text>nzflora</Text>
          <HitCount>142</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>nzfungi</Text>
          <HitCount>96</HitCount>
        </FilterTerm>
        <FilterTerm>
          <Text>nzib</Text>
          <HitCount>25</HitCount>
        </FilterTerm>
      </FilterTerms>
    </FilterField>
  </FilterFields>
  <Results>
    <NameResult>
      <Score>1</Score>
      <NameId>6816ec76-caa5-431a-8dd3-00627d02e319</NameId>
      <NameClassName>Scientific Name</NameClassName>
      <GoverningCode>ICBN</GoverningCode>
      <FullName>Lichina confinis (O.F.Müll.) C.Agardh 1821</FullName>
      <PartialName>Lichina confinis</PartialName>
      <TaxonRankName>species</TaxonRankName>
      <Authorship>(O.F.Müll.) C.Agardh</Authorship>
      <AcceptedNameFullName>Lichina confinis (O.F.Müll.) C.Agardh 1821</AcceptedNameFullName>
      <AcceptedNameTaxonRankName>species</AcceptedNameTaxonRankName>
      <HighestLevelNameFullName>Fungi Whittaker</HighestLevelNameFullName>
      <HighestLevelNamePartialName>Fungi Whittaker</HighestLevelNamePartialName>
      <HigherClassification>kingdom: Fungi Whittaker; subkingdom: Dikarya; phylum: Ascomycota Caval.-Sm. 1998; subphylum: Pezizomycotina O.E. Erikss. &amp; Winka 1997; class: Lichinomycetes Reeb, Lutzoni &amp; Cl. Roux 2004; order: Lichinales Henssen &amp; Büdel 1986; family: Lichinaceae Nyl. 1854; genus: Lichina C.Agardh 1817; species: Lichina confinis (O.F.Müll.) C.Agardh 1821</HigherClassification>
    </NameResult>
    <NameResult>
      <Score>1</Score>
      <NameId>83d5e02c-8ac4-420f-ac7b-00b0c1bfc15d</NameId>
      <NameClassName>Scientific Name</NameClassName>
      <GoverningCode>ICBN</GoverningCode>
      <FullName>Fusarium lichenicola C. Massal. 1903  [as 'Fusarium lichenicolum']</FullName>
      <PartialName>Fusarium lichenicola  [as 'Fusarium lichenicolum']</PartialName>
      <TaxonRankName>species</TaxonRankName>
      <Authorship>C. Massal.</Authorship>
      <AcceptedNameFullName>Cylindrocarpon lichenicola (C. Massal.) D. Hawksw. 1979</AcceptedNameFullName>
      <AcceptedNameTaxonRankName>species</AcceptedNameTaxonRankName>
      <HighestLevelNameFullName>Fungi Whittaker</HighestLevelNameFullName>
      <HighestLevelNamePartialName>Fungi Whittaker</HighestLevelNamePartialName>
      <HigherClassification>kingdom: Fungi Whittaker; anamorph: hyphomycete; genus: Fusarium Link 1809; species: Fusarium lichenicola C. Massal. 1903  [as 'Fusarium lichenicolum']</HigherClassification>
    </NameResult>
    
    ...
  
    <NameResult>
      <Score>1</Score>
      <NameId>ebe07168-0142-4d1e-a92c-075a8b6c844e</NameId>
      <NameClassName>Scientific Name</NameClassName>
      <GoverningCode>ICBN</GoverningCode>
      <FullName>Licuala Thunb.</FullName>
      <PartialName>Licuala</PartialName>
      <TaxonRankName>genus</TaxonRankName>
      <Authorship>Thunb.</Authorship>
      <AcceptedNameFullName>Licuala Thunb.</AcceptedNameFullName>
      <AcceptedNameTaxonRankName>genus</AcceptedNameTaxonRankName>
      <HighestLevelNameFullName>Plantae</HighestLevelNameFullName>
      <HighestLevelNamePartialName>Plantae</HighestLevelNamePartialName>
      <HigherClassification>kingdom: Plantae; phylum: Spermatophyta; class: Magnoliopsida Brongn.; order: Arecales Bromhead; family: Palmae; genus: Licuala Thunb.</HigherClassification>
    </NameResult>
  </Results>
</NameSearchResponse>
  • No labels