NCnceas
Parties

Get all parties

Changed on

Retrieve a paginated collection of all parties recorded in VegBank.

get/parties

Request

Query parameters

searchstring

Search term used for full-text record retrieval

sort'default' | '+default' | '-default' | 'surname' | '+surname' | '-surname' | 'organization_name' | '+organization_name' | '-organization_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
  • surname - Sort by surname
  • organization_name - Sort by organization name
  • obs_count - Sort by observation count

Examples:

  • sort=surname - Sort by surname ascending
  • sort=-obs_count - Sort by observation count descending
  • sort=+organization_name - Sort by organization 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 party or parties

py_codestring

VegBank party identifier

party_labelstring

Name/label for the party

salutationstring

Salutation used in addressing an individual with a particular title

given_namestring

All names, except the surname, of the individual associated with the resource. Possible usages include: first name and middle name, first name and middle initials, first name, etc.

middle_namestring

Middle name or initial, if any

surnamestring

Name shared in common to identify the members of a family, as distinguished the given name

organization_namestring

Full name of the organization, which may be the party itself if this is an organization-type party record, or else is the organization that the party is associated with if this is a person-type party record

contact_instructionsstring

Instructions for contacting a party

obs_countinteger

Number of plot observations associated with this entity

Example response

{
  "py_code": "py.1",
  "party_label": "NatureServe (organization)",
  "salutation": "Dr.",
  "given_name": "Jo R.",
  "middle_name": "R.",
  "surname": "Smith",
  "organization_name": "NatureServe",
  "contact_instructions": "contact the contributor at specified email",
  "obs_count": 17
}

Changes

  • 2e123831df6eRevision changes
    • 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

      the response's body type changed from object to no type for 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

    • warning

      deleted the query request parameter detail

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get-py was added

    • info

      api tag Parties added

    • info

      added the new optional query request parameter create_parquet

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • 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