GetReferringTConcepts Method of TaxonAPI

Description

The TaxonConcepts that refer, through a TaxonRelationship?, to the ids of the TaxonConcepts passed in. This method enables traversal of the TaxonConcept graph. There are currently 22 possible relationship types listed in the TaxonConceptSchema.

There is an optional parameter to restrict the call to a subset of relationship types. This would make it possible to retrieve only "is parent taxon of" and "is child taxon of" relationships for example if the client were building a taxonomic tree structure.

There are currently 22 relationship type in TCS:

• is congruent to
• is not congruent to
• includes
• does not include
• excludes
• is included in
• is not included in
• overlaps
• does not overlap
• is child taxon of
• is parent taxon of
• is anamorph of
• is teleomorph of
• is second parent of
• is female parent of
• is first parent of
• is male parent of
• is hybrid parent of
• is hybrid child of
• is ambiregnal of
• is vernacular for
• has vernacular
• has synonym

Parameters

Name	TCS Concept	Type	Default	Description
ids	/Dataset/TaxonConcepts/TaxonConcept@id	Array of Strings	none	A list of the ids of TaxonConcepts that the requested names refer to.
relationships	-	Array of Strings	null	A list of relationship types to restrict the search to.
start	-	int	0	The index of the first record to be returned. Defaults to zero
limit	-	int	-	The maximum number of results to be returned. Default is publisher dependent

Returns

A valid TCS document containing TaxonConcept objects that refer to one of the IDs in the array supplied or an empty XML document if none are found. Supporting objects, such as Specimen and Reference structures that are referred to by the TaxonConcepts may also be included.

Notes

Paging is supported by this method (TaxonAPIPaging).

-- RogerHyam - 24 Nov 2005