Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Compared with the EcoPlots API search query, the only added field in the request body is related to the "query" parameter. This parameter provides users with the flexibility to choose between a full-text search or tokenised word search for a given species name across all the records stored in the database using either a full-text or a tokenised word search.

For example, when the "exact_match" is set to true and the given speciesname is Allocasuarina torulosa. The ,the API will be returning return only the documents entries containing the exact species name while setting it as it has been entered. Setting "exact_match" to false will result in documents entries that has contain either Allocasuarina or torulosa or the full name of Allocasuarina torulosa.

...

Below is an example of a request body.

...