NCnceas
References

Get all references

Changed on

Retrieve a paginated collection of all references recorded in VegBank.

get/references

Request

Query parameters

searchstring

Search term used for full-text record retrieval

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 reference(s)

rf_codestring

VegBank reference identifier

rf_labelstring

Label for the reference

short_namestring

Concise or abbreviated name that describes the resource being documented

full_citationstring

Full text of the reference citation

reference_typestring

Type of reference

titlestring

Formal title given to the work by its author or publisher, providing a description of the resource sufficient to differentiate it from other similar resources

publication_datestring date

Date that the resource was published

total_pagesinteger

Total number of pages in the resource being described

publisherstring

Organization that physically put together the report and publishes it

publication_placestring

Location where the work was published

degreestring

Name or degree level for which the thesis was completed

isbnstring

The ISBN, or International Standard Book Number that has been assigned to this literature resource

urlstring

URL (Uniform Resource Locator) identifying where the resource and/or additional information about it is (or was) available

doistring

DOI (Digital Object Identifier) serving as the persistent identifier for the resource

journalstring

Name of the journal, magazine, etc. in which the article was published

Example response

{
  "rf_code": "rf.1",
  "rf_label": "Peet Dissertation (1975)",
  "short_name": "Anderson, L. et al. 1990.",
  "full_citation": "Anderson, L. et al. 1990. Bryologist 93: 448-499.",
  "reference_type": "Report",
  "title": "The Biology of Lichens",
  "publication_date": "2011-08-25",
  "total_pages": 17,
  "publisher": "NCU Herbarium",
  "publication_place": "Chapel Hill, NC, USA",
  "degree": "PhD",
  "isbn": "978-1-889878-38-6",
  "url": "http://www.algaebase.org",
  "doi": "10.1000/182",
  "journal": "Regnum Vegetabile"
}

Changes

  • 2e123831df6eRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      deleted the query request parameter accession_code

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get-rf was added

    • info

      api tag References added

    • info

      added the new optional query request parameter create_parquet

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter search

    • info

      added to the response body allOf list for the response status

    • 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