NCnceas
Community classifications

Get all community classifications

Changed on

Retrieve a paginated collection of all community classifications recorded in VegBank.

get/community-classifications

Request

Query parameters

detail'minimal' | 'full'

Level of detail for the response:

  • minimal: Returns basic fields only
  • full: Returns more fields
with_nestedboolean

Whether to include nested fields in the response

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"
    }
  ]
}

Changes

  • 2e123831df6eRevision changes
    • breaking

      the query request parameter detail was restricted to a list of enum values

    • breaking

      for the query request parameter detail, default value full was added

    • breaking

      for the query request parameter limit, default value 1000 was added

    • breaking

      for the query request parameter offset, default value 0 was added

    • breaking

      added to the response body oneOf list for the response status

    • warning

      for the query request parameter limit, the min was set to 0.00

    • warning

      for the query request parameter offset, the min was set to 0.00

    • info

      api operation id get-cl was added

    • info

      api tag Community classifications added

    • info

      added the new optional query request parameter create_parquet

    • info

      added the new optional query request parameter with_nested

    • info

      added the new enum value full to the query request parameter detail

    • info

      added the new enum value minimal to the query request parameter detail

    • info

      added the media type application/vnd.apache.parquet for the response with the status

    • info

      added the non-success response with the status

  • 16a2946a00d0Revision changes
    • info

      endpoint added