wiki-archive/twiki/data/TIP/TaxonAPIGetTNamesMatching.txt

22 lines
863 B
Plaintext

%META:TOPICINFO{author="RogerHyam" date="1132848979" format="1.1" version="1.1"}%
%META:TOPICPARENT{name="TaxonAPI"}%
---+ <nop>GetTNamesMatching Method of TaxonAPI
---++ Description
Retrieves TaxonNames that match the filter passed in. See TaxonAPIMatching for details. This method supports paging and the paging parameters. See TaxonAPIPaging for details.
---++ Parameters
Includes the standard parameters listed in TaxonAPIMatching and TaxonAPIPaging.
---++ Returns
A valid TCS document containing TaxonName objects that match the filter supplied or an empty XML document if none are found. Supporting objects, such as Specimen and Reference structures that are referred to by the TaxonNames may also be included.
---++ Notes
This method supports paging as lists may be very long - all names matching "A%" for example.
-- Main.RogerHyam - 24 Nov 2005