Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Community concepts

Get community concepts by rf

Retrieve a paginated and sorted collection of the community concepts associated with a given reference (using its rf_code), or a subset thereof based on a specified search query.

get/references/{rf_code}/community-concepts

Path parameters

rf_codestring required

Query parameters

searchstring

Search term used for full-text record retrieval

status'any' | 'current' | 'accepted' | 'current_accepted'

Status criterion for returned plant concepts and their children:

  • any: Returns matching concepts regardless of status
  • current: Only returns concepts that don't have (past) status stop dates
  • accepted: Only returns concepts that have an accepted status
  • current_accepted: Only returns concepts that are both current and accepted
with_nestedboolean

Whether to include nested fields in the response

sort'default' | '+default' | '-default' | 'comm_name' | '+comm_name' | '-comm_name' | 'obs_count' | '+obs_count' | '-obs_count'

Sort order for results. Prefix with - for descending order or + for ascending order. Ascending order is the default if no prefix is provided.

Available sort fields:

  • default - Default sort order
  • comm_name - Sort by community name
  • obs_count - Sort by observation count

Examples:

  • sort=comm_name - Sort by community name ascending
  • sort=-obs_count - Sort by observation count descending
  • sort=+comm_name - Sort by community name ascending (explicit)
limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching community concept(s), with fields based on parameters:

  • detail=full&with_nested=false: Extended fields, no nested array fields
  • detail=full&with_nested=true: Extended fields + nested array fields
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "cc_code": "cc.1",
      "comm_name": "Muhlenbergia rigens Wet Meadow",
      "comm_code": "CEGL005306",
      "comm_description": "This herbaceous bunchgrass association has been documented in...",
      "concept_rf_code": "rf.1",
      "concept_rf_label": "NatureServe Biotics 2019",
      "status_rf_code": "rf.1",
      "status_rf_label": "NatureServe Biotics 2019",
      "obs_count": 17,
      "comm_level": "Association",
      "status": "accepted",
      "start_date": "2006-05-30",
      "stop_date": "2006-05-30",
      "current_accepted": true,
      "py_code": "py.1",
      "party_label": "NatureServe (organization)",
      "comm_party_comments": "This association is the result of...",
      "parent_cc_code": "cc.1",
      "parent_name": "Leymus cinereus - Leymus triticoides Alkaline Wet Meadow Alliance"
    }
  ]
}