v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Community classifications

Get community classifications by ob

Retrieve a paginated collection of community classifications associated with the specified plot observation (using its ob_code).

get/plot-observations/{ob_code}/community-classifications

Path parameters

ob_codestring required

Query parameters

searchstring

Search term used for full-text record retrieval

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 classification(s), with fields based on parameters:

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

Example response

{
  "count": 115000,
  "data": [
    {
      "cl_code": "cl.1",
      "ob_code": "ob.1",
      "class_start_date": "2006-05-30",
      "class_stop_date": "2006-05-30",
      "expert_system": "DCA, UPGMA",
      "class_publication_rf_code": "rf.1",
      "class_publication_rf_label": "NVC 2004",
      "class_notes": "Abies Grandis Alliance"
    }
  ]
}