GET api/verify?name={name}&bestMatchOnly={bestMatchOnly}&resolveOnce={resolveOnce}

Find a correct match of a submitted name to names in all SANBI sources.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

A string scientific name

 string

Required
bestMatchOnly

Returns just one result with the highest score. (Default = true)

 boolean

Default value is False
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. (Default = false)

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Taxon name match(es) found

ResolvedResponse
NameDescriptionTypeAdditional 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.