wiki-archive/twiki/data/TIP/TaxonAPIGetTConceptsByID.txt,v

47 lines
1.2 KiB
Plaintext

head 1.1;
access;
symbols;
locks; strict;
comment @# @;
expand @o@;
1.1
date 2005.11.24.16.33.47; author RogerHyam; state Exp;
branches;
next ;
desc
@none
@
1.1
log
@none
@
text
@%META:TOPICINFO{author="RogerHyam" date="1132850026" format="1.1" version="1.1"}%
%META:TOPICPARENT{name="TaxonAPI"}%
---+ <nop>GetTConceptsByID Method of TaxonAPI
---++ Description
Retrieves one or more TaxonConcepts by their ID field.
---++ Parameters
|*Name*|*TCS Concept*|*Type*|*Default*|*Description*|
|ids|//Dataset/TaxonConcepts/TaxonConcept@@id|Array of Strings| none|A list of ids of TaxonConcepts to be returned|
---++ Returns
A valid TCS document containing TaxonConcept objects that have one of the IDs in the array supplied or an empty XML document if none are found. Supporting structures, such as TaxonNames, Specimens and Reference structures that are referred to by the TaxonConcepts may also be included. It is quite likely that a publisher will want to include TaxonName objects in the response in order to provide tokenisation of the names used by the TaxonConcepts.
---++ Notes
There is no paging supported by this method. Clients may request as long a list of ids as they like. Data publishers may, of course, refuse to respond.
-- Main.RogerHyam - 24 Nov 2005@