NCnceas
Stem counts

Get stem count

Changed on

Retrieve a single stem count using its sc_code.

get/stem-counts/{sc_code}

Request

Path parameters

sc_codestring required

Query parameters

detail'minimal' | 'full'

Level of detail for the response:

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

If true, return data payload in binary Parquet format

Response

Matching stem count(s), with fields based on parameters:

  • detail=minimal: Basic fields only
  • detail=full: Extended fields
OR

Example response

{
  "count": 115000,
  "data": [
    {
      "ob_code": "ob.1",
      "to_code": "to.1",
      "tm_code": "tm.1",
      "sr_code": "sr.1",
      "sc_code": "sc.1",
      "diameter": 3.75,
      "diameter_accuracy": 1.25,
      "height": 1.185,
      "height_accuracy": 0.185,
      "count": 1,
      "taxon_area": 600
    }
  ]
}

Changes

  • c37c8d7a84c5Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • info

      added the new optional query request parameter detail

    • info

      removed from the response body allOf list for the response status

  • dafd6d522f81Revision changes
    • info

      endpoint added