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

43 lines
1.1 KiB
Plaintext

head 1.1;
access;
symbols;
locks; strict;
comment @# @;
1.1
date 2005.11.24.16.06.05; author RogerHyam; state Exp;
branches;
next ;
desc
@none
@
1.1
log
@none
@
text
@%META:TOPICINFO{author="RogerHyam" date="1132848365" format="1.1" version="1.1"}%
%META:TOPICPARENT{name="TaxonAPI"}%
---+ <nop>GetTNamesByID Method of TaxonAPI
---++ Description
Retrieves one or more TaxonNames by their ID field (/Dataset/TaxonNames/TaxonName@@id).
---++ Parameters
|*Name*|*TCS Concept*|*Type*|*Default*|*Description*|
|ids|/Dataset/TaxonNames/TaxonName@@id|Array of Strings| none|A list of id of TaxonNames to be returned|
---++ Returns
A valid TCS document containing TaxonName objects that have one of the IDs in the array supplied or an empty XML document if none are found. Supporting structures, such as Voucher and Reference strucutures that are referred to by the TaxonNames may also be included.
---++ 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
@