Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Cover methods

Get all cover methods

Retrieve a paginated collection of all cover methods recorded in VegBank.

get/cover-methods

Query parameters

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 cover method(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": [
    {
      "cm_code": "cm.1",
      "cover_type": "Braun-Blanquet",
      "cover_estimation_method": "Canopy cover",
      "rf_code": "rf.1",
      "rf_label": "TurboVeg1.98a"
    }
  ]
}