POST api/verify

Find a correct match of a submitted name to names in some SANBI and/or some other data sources.

Request Information

URI Parameters

None.

Body Parameters

The request.

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.

Request Formats

application/json, text/json

Sample:

{
  "NameItem": {
    "Name": "sample string 1",
    "SuppliedId": "sample string 2"
  },
  "DataSourceIds": "sample string 1",
  "ResolveOnce": true,
  "BestMatchOnly": true,
  "PreferredDataSources": "sample string 2",
  "WithContext_NOTUSED": true,
  "WithCanonicalRanks": true,
  "WithGlobalNamesVerifications": true
}

application/xml, text/xml

Sample:

<ResolveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sanbi.Taxonomy.Backbone.Api.Models">
  <BestMatchOnly>true</BestMatchOnly>
  <DataSourceIds>sample string 1</DataSourceIds>
  <NameItem>
    <Name>sample string 1</Name>
    <SuppliedId>sample string 2</SuppliedId>
  </NameItem>
  <PreferredDataSources>sample string 2</PreferredDataSources>
  <ResolveOnce>true</ResolveOnce>
  <WithCanonicalRanks>true</WithCanonicalRanks>
  <WithContext_NOTUSED>true</WithContext_NOTUSED>
  <WithGlobalNamesVerifications>true</WithGlobalNamesVerifications>
</ResolveRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Taxon name match(es) found

ResolvedResponse

Name	Description	Type	Additional information
status	The final status of the request -- 'success' or 'failure'	ResolvedStatus	None.
names	An array of verification results.	Collection of ResolvedDataItem	None.
message	Message associated with the status	string	None.
globalNamesVerifications	Message associated with the status	ResolvedResponse	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.