wiki-archive/twiki/data/TIP/TaxonAPIGetTConceptsMatchin...

18 lines
1.1 KiB
Plaintext

%META:TOPICINFO{author="RogerHyam" date="1132851865" format="1.1" version="1.1"}%
%META:TOPICPARENT{name="TaxonAPI"}%
---+ <nop>GetTConceptsMatching Method of TaxonAPI
---++ Description
Retrieves TaxonConcepts that match the filter passed in. Note that the matching includes matching on a join of TaxonNames with TaxonConcepts. 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 TaxonConcept objects that match the filter supplied or an empty XML document if none are found. Supporting objects, such as TaxonName, Specimen and Reference structures that are referred to by the TaxonConcepts may also be included. It is likely the publisher will want to return TaxonName objects in order to tokenize the names used in the concepts.
---++ Notes
This method supports paging as lists may be very long - all names matching "A%" for example.
-- Main.RogerHyam - 24 Nov 2005