Name Matching REST API

The most powerful way to query the name matching service is via the GraphQL API however for some applications a very simple REST service is sufficient. That is what is provided here. This service should be seen as a chopped down version of the GraphQL API. Behind the scenes it uses the same code. If you need more complex behaviour you are encouraged to explore the GraphQL API which can be called without the use of client side libraries if necessary.

Test Form

Use this form to test how name strings are parsed and matched.


Check Homonyms: Check Rank: Accept Single Candidate:

Requests and Responses

Only GET requests are supported. All parameters are optional. Calling without the "input_string" parameter will return this page. All requests that provide a value in the "input_string" parameter will be responded to with a JSON object equivalent to the taxonNameMatch response object provided by the GraphQL API.

Request Parameters

Response

A JSON object is returned with the following properties

The name objects will have the following properties.

If you would like more complex information back about the name and its placement in different classifications you are encouraged to use the GraphQL API or you could call the names Stable URI to get a JSON representation of it.

Examples

Perfect match

https://list.worldfloraonline.org/matching_rest.php?input_string=Rhopalocarpus+alternifolius+(Baker)+Capuron

Imperfect match

https://list.worldfloraonline.org/matching_rest.php?input_string=Rhopalocarpus+alternifolius+(Baker)+Capuron

GraphQL equivalent

This is an example of a similar matching call using a GraphQL query. It could be extended to include appropriate parts of the graph of TaxonName and TaxonConcept objects as required.

query {
  taxonNameMatch(inputString: "Rhopalocarpus alternifolium (Baker) Capuro") {
    inputString
    searchString
    match {
      wfoId
      fullNameStringPlain
      fullNameStringHtml
    }
    candidates {
      wfoId
      fullNameStringPlain
      fullNameStringHtml
    }
    narrative
  }
}