Name | Description | Type | Additional information |
---|---|---|---|
NameItem |
Name Item to be resolved |
ResolveRequestItem |
None. |
DataSourceIds |
Optional pipe-delimited list of data sources. |
string |
None. |
ResolveOnce |
Find the first available match instead of matches across all data sources with all possible renderings of a name. When 'true', response is rapid but incomplete. |
boolean |
None. |
BestMatchOnly |
Returns just one result with the highest score |
boolean |
None. |
PreferredDataSources |
A pipe-delimited list of data sources (see data_source_ids parameter). Creates a new section in results -- 'preferred_results' in addition to 'results'. Preferred results contain only data received from requested data sources. When used together with 'best_match_only' returnes only one highest scored result per a preffered data source. The resolution is still performed according to 'data_source_id' parameter. |
string |
None. |
WithContext_NOTUSED |
Reduce the likelihood of matches to taxonomic homonyms. When 'true' a common taxonomic context is calculated for all supplied names from matches in data sources that have classification tree paths. Names out of determined context are penalized during score calculation. |
boolean |
None. |
WithCanonicalRanks |
Returns 'CanonicalForm' with infraspecific ranks, if they are present. |
boolean |
None. |
WithGlobalNamesVerifications |
Include GNverifier results helps to find a correct match of submitted name strings to names in all or some data sources. When include the 'GlobalNamesVerifications' property will be populated. |
boolean |
None. |