NAV navbar
logo

TaxonWorks API Documentation

version v1
baseUri https://{host}/api/{version}
protocols HTTPS
mediaType application/json

Introduction

This is the documentation for external TaxonWorks API endpoints. Documentation source is at https://github.com/SpeciesFileGroup/taxonworks_api. In brief this allows users to access data curated in a copy of TaxonWorks via a user or project (anonymous) level token.

Servers with live APIs

Each instance of TaxonWorks serves its own API. Add your instance to this list with a pull request.

Roadmap

Our approach:

  • v1 (current)
    • Goal is to expose existing internal endpoints that the application is built upon
    • Endpoints are practical, in that they are nearly being used in interfaces, but not necessarily optimized
    • Largely JSON based, and are derived from Rails conventions
  • v2 (planned)
    • Optimize existing routes, remove nestedness where it makes sense
    • Increase standardization of traits (params) across endpoints
    • Explore delayed responses/ticketing system for long running queries
  • v3 (planned)
    • Integrate caching other optimizations optimization
    • Perhaps move to a fully cached solution, using GraphQL
    • May move cache to a graph DB or other flattened indexer

Running an api-console

This both lets you read the API documentation and experiment directly therein against a local rails server (localhost:3000).

You must have a TaxonWorks instance running at localhost:3000 (rails s, see install_taxonworks) before sending API requests though the console.

Use npm install if you haven't already. Then just run npm start -- --open (-- --open is optional, it will make your browser open the URL the console is being served from).

Once it is ready to explore you should see something like this:

$ npm start -- --open

(OUTPUT OMITTED)

API console build ready.
Thanks for using our API tools!

Files in this directory are available under the following URLs
      applications: http://127.0.0.1:8081

NOTE: It might display a white screen when the browser opens the URL (specially true with Firefox, Chrome seems inmune to this problem). Refresh a few times until it shows the documentation.

Other endpoints

From your terminal within the source directory (not this repo) use rake routes to get a list of all endpoints. Endpoints are defined as Rails routes in /config/routes/api*.

Types

TaxonNameItem


Properties

id

TaxonName instance identifier

PropertyValue
requiredtrue
typenumber
examples25225

name

The fully latinized string (monomimial) of a code governed taxonomic biological name not applicable for Combinations, they are derived from their pieces.

PropertyValue
requiredtrue
typestring
examplesasymmetricus

parent_id

The id of the parent taxon. The parent child relationship is exclusively organizational. All statuses and relationships of a taxon name must be explicitly defined via taxon name relationships or classifications. The parent of a taxon name can be thought of as "the place where you'd find this name in a hierarchy if you knew literally nothing else about that name." In practice read each monomial in the name (protonym or combination) from right to left, the parent is the parent of the last monomial read. There are 3 simple rules for determening the parent of a Protonym or Combination:

1) the parent must always be at least one rank higher than the target names rank 2) the parent of a synonym (any sense) is the parent of the synonym's valid name 3) the parent of a combination is the parent of the highest ranked monomial in the epithet (almost always the parent of the genus)

PropertyValue
requiredtrue
typeinteger
examples2

year_of_publication

Sensu ICZN - the 4 digit year when this name was published, i.e. made available. Not the publishers date stamped on the title page, but the actual date of publication. Precedence for taxon name publication year is TaxonName#year_of_publication, Source#year, Source#stated_year.

PropertyValue
requiredtrue
typeinteger
examplesnil

verbatim_author

The verbatim author string as provided ? is not post-filled in when Source is referenced !?

PropertyValue
requiredtrue
typestring

rank_string

Rank (Kindom, Phylum...) as a string, like {NomenclaturalRank::Iczn::SpeciesGroup::Species}

PropertyValue
requiredtrue
typestring

type

The subclass of this taxon name, e.g. Protonym or Combination.

PropertyValue
requiredtrue
typestring

masculine_name

Species name which are adjective or participle change depending on the gender of the genus. 3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification. The gender of a genus also designated as a taxon_name_classification.

PropertyValue
requiredtrue
typestring

feminine_name

Species name which are adjective or participle change depending on the gender of the genus. 3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification. The gender of a genus also designated as a taxon_name_classification.

PropertyValue
requiredtrue
typestring

neuter_name

Species name which are adjective or participle change depending on the gender of the genus. 3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification. The gender of a genus also designated as a taxon_name_classification.

PropertyValue
requiredtrue
typestring

project_id

The project ID

PropertyValue
requiredtrue
typeinteger

verbatim_name

A representation of what the combination (fully spelled out) or protonym (monomial) looked like in its originating publication. The sole purpose of this string is to represent visual differences from what is recorded in the latinized version of the name (Protonym#name, Combination#cached) from what was originally transcribed. This string should NOT include the author year (see verbatim_author and year_of_publication for those data).

PropertyValue
requiredtrue
typestring

etymology

The derivation and history of the name in written form.

PropertyValue
requiredtrue
typestring

cached

Genus-species combination for genus and lower, monomial for higher. The string has NO html, and no author/year.

PropertyValue
requiredtrue
typestring

cached_html

As in cached but with tags.

PropertyValue
requiredtrue
typestring

cached_author_year

Author and year string with parentheses where necessary, i.e. with context of present placement for ICZN.

PropertyValue
requiredtrue
typeunion

nomenclatural_code

The name of the nomenclatural code, as a short symbol (:iczn, :icn), or nil

PropertyValue
requiredtrue
typeunion

name_string

The current name/combination with author year, without HTML.

PropertyValue
requiredtrue
typestring

original_combination

The name in original combination, with author year, with HTML.

PropertyValue
requiredtrue
typestring

TYPE DEFINITION

{
  "name": "TaxonNameItem",
  "type": "object",
  "properties": [
    {
      "type": "number",
      "name": "id",
      "displayName": "id",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "TaxonName instance identifier",
      "examples": [
        {
          "value": "25225",
          "strict": true,
          "name": null,
          "structuredValue": 25225
        }
      ],
      "key": "id"
    },
    {
      "type": "string",
      "name": "name",
      "displayName": "name",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The fully latinized string (monomimial) of a code governed taxonomic biological name not \napplicable for Combinations, they are derived from their pieces.\n",
      "examples": [
        {
          "value": "asymmetricus",
          "strict": true,
          "name": null,
          "structuredValue": "asymmetricus"
        }
      ],
      "key": "name"
    },
    {
      "type": "integer",
      "name": "parent_id",
      "displayName": "parent_id",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The id of the parent taxon. The parent child relationship is exclusively organizational. All statuses and relationships\nof a taxon name must be explicitly defined via taxon name relationships or classifications. The parent of a taxon name\ncan be thought of as  \"the place where you'd find this name in a hierarchy if you knew literally *nothing* else about that name.\"\nIn practice read each monomial in the name (protonym or combination) from right to left, the parent is the parent of the last monomial read.\nThere are 3 simple rules for determening the parent of a Protonym or Combination:\n  1) the parent must always be at least one rank higher than the target names rank\n  2) the parent of a synonym (any sense) is the parent of the synonym's valid name\n  3) the parent of a combination is the parent of the highest ranked monomial in the epithet (almost always the parent of the genus)\n",
      "examples": [
        {
          "value": "2",
          "strict": true,
          "name": null,
          "structuredValue": 2
        }
      ],
      "key": "parent_id"
    },
    {
      "type": "integer",
      "name": "year_of_publication",
      "displayName": "year_of_publication",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Sensu ICZN - the 4 digit year when this name was published, i.e. made available. Not the publishers date stamped on the title page,\nbut the actual date of publication. Precedence for taxon name publication year is TaxonName#year_of_publication, Source#year, Source#stated_year.\n",
      "examples": [
        {
          "value": "nil",
          "strict": true,
          "name": null,
          "structuredValue": "nil"
        }
      ],
      "key": "year_of_publication"
    },
    {
      "type": "string",
      "name": "verbatim_author",
      "displayName": "verbatim_author",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The verbatim author string as provided ? is not post-filled in when Source is referenced !?\n",
      "key": "verbatim_author"
    },
    {
      "type": "string",
      "name": "rank_string",
      "displayName": "rank_string",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Rank (Kindom, Phylum...) as a string, like {NomenclaturalRank::Iczn::SpeciesGroup::Species}\n",
      "key": "rank_string"
    },
    {
      "type": "string",
      "name": "type",
      "displayName": "type",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The subclass of this taxon name, e.g. Protonym or Combination.\n",
      "key": "type"
    },
    {
      "type": "string",
      "name": "masculine_name",
      "displayName": "masculine_name",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Species name which are adjective or participle change depending on the gender of the genus.\n3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification.\nThe gender of a genus also designated as a taxon_name_classification.\n",
      "key": "masculine_name"
    },
    {
      "type": "string",
      "name": "feminine_name",
      "displayName": "feminine_name",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Species name which are adjective or participle change depending on the gender of the genus.\n3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification.\nThe gender of a genus also designated as a taxon_name_classification.\n",
      "key": "feminine_name"
    },
    {
      "type": "string",
      "name": "neuter_name",
      "displayName": "neuter_name",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Species name which are adjective or participle change depending on the gender of the genus.\n3 fields provide alternative species spelling. The part_of_speech is designated as a taxon_name_classification.\nThe gender of a genus also designated as a taxon_name_classification.\n",
      "key": "neuter_name"
    },
    {
      "type": "integer",
      "name": "project_id",
      "displayName": "project_id",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The project ID\n",
      "key": "project_id"
    },
    {
      "type": "string",
      "name": "verbatim_name",
      "displayName": "verbatim_name",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "A representation of what the combination (fully spelled out) or protonym (monomial) *looked like* in its originating publication.\nThe sole purpose of this string is to represent visual differences from what is recorded in the\nlatinized version of the name (Protonym#name, Combination#cached) from what was originally transcribed.\nThis string should NOT include the author year (see verbatim_author and year_of_publication for those data).\n",
      "key": "verbatim_name"
    },
    {
      "type": "string",
      "name": "etymology",
      "displayName": "etymology",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The derivation and history of the name in written form.\n",
      "key": "etymology"
    },
    {
      "type": "string",
      "name": "cached",
      "displayName": "cached",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Genus-species combination for genus and lower, monomial for higher. The string has NO html, and no author/year.\n",
      "key": "cached"
    },
    {
      "type": "string",
      "name": "cached_html",
      "displayName": "cached_html",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "As in `cached` but with <i></i> tags.\n",
      "key": "cached_html"
    },
    {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "nil"
        }
      ],
      "type": "union",
      "name": "cached_author_year",
      "displayName": "cached_author_year",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Author and year string with parentheses where necessary, i.e. with context of present placement for ICZN.\n",
      "fixedFacets": {
        "description": "Author and year string with parentheses where necessary, i.e. with context of present placement for ICZN.\n"
      },
      "key": "cached_author_year"
    },
    {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "nil"
        }
      ],
      "type": "union",
      "name": "nomenclatural_code",
      "displayName": "nomenclatural_code",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The name of the nomenclatural code, as a short symbol (:iczn, :icn), or nil\n",
      "fixedFacets": {
        "description": "The name of the nomenclatural code, as a short symbol (:iczn, :icn), or nil\n"
      },
      "key": "nomenclatural_code"
    },
    {
      "type": "string",
      "name": "name_string",
      "displayName": "name_string",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The current name/combination with author year, without HTML.\n",
      "key": "name_string"
    },
    {
      "type": "string",
      "name": "original_combination",
      "displayName": "original_combination",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "The name in original combination, with author year, with HTML.\n",
      "key": "original_combination"
    }
  ]
}

TaxonNameAutocompleteItem


Properties

id

TaxonName instance identifier

PropertyValue
requiredtrue
typenumber
examples11877

label

Plaintext label for the taxon name comprised of both scientific name and authorship.

PropertyValue
requiredtrue
typestring
examplesJivarus Giglio-Tos, 1898

label_html

HTML-formatted label for the taxon name comprised of both scientific name and authorship.

PropertyValue
requiredtrue
typestring
examples Jivarus Giglio-Tos, 1898     

TYPE DEFINITION

{
  "name": "TaxonNameAutocompleteItem",
  "type": "object",
  "properties": [
    {
      "type": "number",
      "name": "id",
      "displayName": "id",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "TaxonName instance identifier",
      "examples": [
        {
          "value": "11877",
          "strict": true,
          "name": null,
          "structuredValue": 11877
        }
      ],
      "key": "id"
    },
    {
      "type": "string",
      "name": "label",
      "displayName": "label",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "Plaintext label for the taxon name comprised of both scientific name and authorship.\n",
      "examples": [
        {
          "value": "Jivarus Giglio-Tos, 1898",
          "strict": true,
          "name": null,
          "structuredValue": "Jivarus Giglio-Tos, 1898"
        }
      ],
      "key": "label"
    },
    {
      "type": "string",
      "name": "label_html",
      "displayName": "label_html",
      "typePropertyKind": "TYPE_EXPRESSION",
      "required": true,
      "description": "HTML-formatted label for the taxon name comprised of both scientific name and authorship.\n",
      "examples": [
        {
          "value": "<span class=\"klass\">\n  <i><mark>Jivarus</mark></i> Giglio-Tos, 1898</span>&nbsp;\n  <span class=\"feedback feedback-info feedback-thin\">genus</span>&nbsp;\n  <span class=\"feedback feedback-secondary feedback-thin\">Jivarini</span>&nbsp;\n  <span class=\"feedback feedback-notice feedback-thin\">Jivarus\n</span>\n",
          "strict": true,
          "name": null,
          "structuredValue": "<span class=\"klass\">\n  <i><mark>Jivarus</mark></i> Giglio-Tos, 1898</span>&nbsp;\n  <span class=\"feedback feedback-info feedback-thin\">genus</span>&nbsp;\n  <span class=\"feedback feedback-secondary feedback-thin\">Jivarini</span>&nbsp;\n  <span class=\"feedback feedback-notice feedback-thin\">Jivarus\n</span>\n"
        }
      ],
      "key": "label_html"
    }
  ]
}

/

Base of the API. Includes an index of open projects indexed by project_token.


/ get

GET: /


Possible Responses

200


/ get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/"

RESPONSE BODY

200

{
  "success": true,
  "open_projects": [
    {
      "mFPoRURskHhXu29nbAxoNy": "My TaxonWorks Project"
    }
  ]
}
Type
any

/ping

An open endpoint to test for life.


/ping get

GET: /ping


Possible Responses

200


/ping get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/ping"

RESPONSE BODY

200

{
  "pong": true
}
Type
any

/user_authenticated

A single purpose route to test your User token.


/user_authenticated get

GET: /user_authenticated


Possible Responses

200


/user_authenticated get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/user_authenticated"

RESPONSE BODY

200

{
  "success": true
}
Type
any

/project_authenticated

A single purpose route to test your Project token.


/project_authenticated get

GET: /project_authenticated


Query Parameters

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Possible Responses

200


/project_authenticated get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/project_authenticated?project_token=rIO2oWS603c5W5laQ8ornn"

RESPONSE BODY

200

{
  "success": true,
  "open_projects": [
    {
      "mFPoRURskHhXu29nbAxoNy": "My TaxonWorks Project"
    }
  ]
}
Type
any

/both_authenticated

A single purpose route to test both User and Project tokens.


/both_authenticated get

GET: /both_authenticated


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Possible Responses

200


/both_authenticated get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/both_authenticated?token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE BODY

200

{
  "success": true
}
Type
any

/otus

See Overview at http://rdoc.taxonworks.org/Otu.html


/otus get

GET: /otus

Get all otus, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

otu_id

ID for a single OTU.

PropertyValue
requiredfalse
typeinteger

name

Name (label) of the OTU.

PropertyValue
requiredfalse
typestring

taxon_name_id

ID for a given taxon

PropertyValue
requiredfalse
typeinteger

otu_ids[]

List of OTU IDs.

PropertyValue
requiredfalse
typeinteger array

taxon_name_ids[]

List of taxon name IDs.

PropertyValue
requiredfalse
typeinteger array

taxon_name_relationships_ids[]

List of relationship IDs

PropertyValue
requiredfalse
typeinteger array

taxon_name_classification_ids[]

List of classification IDs.

PropertyValue
requiredfalse
typeinteger array

asserted_distribution_ids[]

List of asserted distribution IDs.

PropertyValue
requiredfalse
typeinteger array

data_attributes_attributes

[ :id, :_destroy, :controlled_vocabulary_term_id, :type, :attribute subject_id:, attribute_subject_type, :value ]

PropertyValue
requiredfalse
typemixed parameter array

page

The page of otus result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of otus per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of otus in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of otus per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/otus get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/otus?page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 1,
    "name": null,
    "taxon_name_id": 46,
    "created_by_id": 5,
    "updated_by_id": 5,
    "project_id": 2,
    "created_at": "2020-09-17T02:19:43.367Z",
    "updated_at": "2020-09-17T02:19:43.367Z",
    "global_id": "gid://taxon-works/Otu/1"
  },
  {
    "id": 2,
    "name": "nympha maris",
    "taxon_name_id": 47,
    "created_by_id": 5,
    "updated_by_id": 5,
    "project_id": 2,
    "created_at": "2020-09-17T02:19:43.419Z",
    "updated_at": "2020-09-17T02:19:43.419Z",
    "global_id": "gid://taxon-works/Otu/2"
  },
  {
    "id": 3,
    "name": null,
    "taxon_name_id": 48,
    "created_by_id": 5,
    "updated_by_id": 5,
    "project_id": 2,
    "created_at": "2020-09-17T02:19:43.451Z",
    "updated_at": "2020-09-17T02:19:43.451Z",
    "global_id": "gid://taxon-works/Otu/3"
  },
  {
    "id": 8485,
    "name": "macula lutea",
    "taxon_name_id": 8519,
    "created_by_id": 24,
    "updated_by_id": 24,
    "project_id": 2,
    "created_at": "2019-09-20T15:37:00.000Z",
    "updated_at": "2019-09-20T15:37:00.000Z",
    "global_id": "gid://taxon-works/Otu/8485"
  }
]
Type
array


/{id} get

GET: /otus/{id}

Returns OTU instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/otus/{id}?token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/downloads

See Overview at http://rdoc.taxonworks.org/Download.html


/downloads get

GET: /downloads

Get all downloads, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/downloads get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/downloads?token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ


/{id} get

GET: /downloads/{id}

Returns Download metadata instance


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples1

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/downloads/{id}?project_id=1&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/taxon_names

See Overview at http://rdoc.taxonworks.org/TaxonName.html


/taxon_names get

GET: /taxon_names

Get all taxon_names, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples1

name

Filter to apply on full taxon name (cached property). Matching is case insensitive. See also exact.

PropertyValue
requiredfalse
typestring
examplesAus

author

Filter by authors (inside cached_author_year property). Matching is case insensitive. Use "&" for "and". See also exact.

PropertyValue
requiredfalse
typestring
examplesSmith & Johnson, 2019

authors

When true then only return taxon names that have an author string present.

PropertyValue
requiredfalse
typeboolean
examples[ true, false, "TRUE", "FALSE", "True", "False" ]

citations

When true then only return taxon names that have citations attached to them.

PropertyValue
requiredfalse
typeboolean
oneOftrue, false, false, false, false, false
examplesfalse

otus

When true then only return taxon names that are linked to one or more Otus.

PropertyValue
requiredfalse
typeboolean
oneOftrue, false, false, false, false, false
examplestrue

type_metadata

Boolean. When true then only return taxon names that are linked to a type specimen (collection object).

PropertyValue
requiredfalse
typestring
oneOftrue, false, TRUE, FALSE, True, False
examplesTRUE

year

Filter by authority year (inside cached_author_year property). Format is 'YYYY'.

PropertyValue
requiredfalse
typestring
examples2019

exact

True if filter matching must be exact, false if partial matches are allowed.

PropertyValue
requiredfalse
typeboolean
examplestrue

updated_since

Names updated (modified_at property) since this datetime.

PropertyValue
requiredfalse
typedatetime
examples2019-05-20T13:30:00

validity

Filter by validity. True if only valid, false if only invalid, nil if both

PropertyValue
requiredfalse
typestring | nil
examplestrue

taxon_name_id[]

Return only taxon names with these ids. To also return children see descendants.

PropertyValue
requiredfalse
typearray
examples[ 1, 5 ]

descendants

Filter by parenthood. When set to true and one or more taxon_name_id values are provided then the request matches taxa which are children of at least one of the taxa specified by the taxon_name_ids. Has no effect if taxon_name_id is not provided.

PropertyValue
requiredfalse
typeboolean
examplestrue

nomenclature_group[]

Filter by nomenclature group.

PropertyValue
requiredfalse
typestring
oneOfHigher, Family, Genus, Species
examplesGenus

nomenclature_code[]

Filter by nomenclature code.

PropertyValue
requiredfalse
typestring
oneOfICZN, ICBN, ICN, ICTV
examplesICZN

taxon_name_relationship_type[]

Filter by names having relationships of these types

PropertyValue
requiredfalse
typearray
examplesTaxonNameRelationship::Iczn::Invalidating

leaves

If 'true' filters by names having no descendents or with descendants if 'false'.

PropertyValue
requiredfalse
typeboolean | nil
examplestrue

taxon_name_type[]

Return only taxon names of the provided class. Case sensitive. Only Protonym, Combination, and Hybrid are supported.

PropertyValue
requiredfalse
typestring
examplesProtonym

page

The page of taxon_names result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of taxon_names per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of taxon_names in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of taxon_names per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/taxon_names get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/taxon_names?project_id=1&name=Aus&author=Smith & Johnson, 2019&authors=[
  true,
  false,
  "TRUE",
  "FALSE",
  "True",
  "False"
]&citations=false&otus=true&type_metadata=TRUE&year=2019&exact=true&updated_since=2019-05-20T13:30:00&validity=true&taxon_name_id[]=[
  1,
  5
]&descendants=true&nomenclature_group[]=Genus&nomenclature_code[]=ICZN&taxon_name_relationship_type[]=TaxonNameRelationship::Iczn::Invalidating&leaves=true&taxon_name_type[]=Protonym&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 25225,
    "name": "asymmetricus",
    "parent_id": 25219,
    "cached": "Spiraphonus asymmetricus",
    "cached_html": "\u003ci\u003eSpiraphonus asymmetricus\u003c/i\u003e",
    "feminine_name": null,
    "masculine_name": null,
    "neuter_name": null,
    "cached_author_year": "Gorochov, 2010",
    "etymology": null,
    "year_of_publication": null,
    "verbatim_author": null,
    "rank": "species",
    "rank_string": "NomenclaturalRank::Iczn::SpeciesGroup::Species",
    "type": "Protonym",
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "cached_valid_taxon_name_id": 25225,
    "cached_original_combination": "Spiraphonus asymmetricus",
    "cached_original_combination_html": "\u003ci\u003eSpiraphonus asymmetricus\u003c/i\u003e",
    "cached_secondary_homonym": "Spiraphonus asymmetricus",
    "cached_primary_homonym": "Spiraphonus asymmetricus",
    "created_at": "2013-02-12T18:23:00.000Z",
    "updated_at": "2019-03-12T22:57:30.813Z",
    "nomenclatural_code": "iczn",
    "verbatim_name": null,
    "name_string": "Spiraphonus asymmetricus Gorochov, 2010",
    "original_combination": "\u003ci\u003eSpiraphonus asymmetricus\u003c/i\u003e Gorochov, 2010"
  }
]
Type
array


/autocomplete get

GET: /taxon_names/autocomplete

Returns a single TaxonName instance with related data included.


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples1

term

The search term by which names will be filtered.

PropertyValue
requiredtrue
typestring
examplesJivarus

type[]

The type of TaxonName (e.g. Protonym, Combination).

PropertyValue
requiredfalse
typearray
examples[ "Combination", "Hybrid" ]

exact

If true TaxonName.name must match the search term exactly to be returned (i.e. no fuzzy matching)

PropertyValue
requiredfalse
typeboolean
examplestrue

valid

Filter by validity. True if only valid, false if only invalid, nil if both

PropertyValue
requiredfalse
typestring | nil
examplestrue

parent_id[]

Filter by all children of these parents. Filter includes supplied parents.

PropertyValue
requiredfalse
typearray
examples[ 1, 5 ]

nomenclature_group[]

Filter by nomenclature group.

PropertyValue
requiredfalse
typearray
examples[ "Genus", "Species" ]

no_leaves

If 'true' names with no children will be excluded.

PropertyValue
requiredfalse
typeboolean
examplestrue

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Possible Responses

200


/autocomplete get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/taxon_names/autocomplete?project_id=1&term=Jivarus&type[]=[
  "Combination",
  "Hybrid"
]&exact=true&valid=true&parent_id[]=[
  1,
  5
]&nomenclature_group[]=[
  "Genus",
  "Species"
]&no_leaves=true&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE BODY

200

[
  {
    "id": 11877,
    "label": "Jivarus Giglio-Tos, 1898",
    "label_html": "\u003cspan class=\"klass\"\u003e\u003ci\u003e\u003cmark\u003eJivarus\u003c/mark\u003e\u003c/i\u003e Giglio-Tos, 1898\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-info feedback-thin\"\u003egenus\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-secondary feedback-thin\"\u003eJivarini\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-notice feedback-thin\"\u003eJivarus\u003c/span\u003e"
  },
  {
    "id": 11888,
    "label": "Jivarus cohni Ronderos, 1979",
    "label_html": "\u003cspan class=\"klass\"\u003e\u003ci\u003e\u003cmark\u003eJivarus\u003c/mark\u003e cohni\u003c/i\u003e Ronderos, 1979\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-info feedback-thin\"\u003especies\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-secondary feedback-thin\"\u003e\u003ci\u003eJivarus\u003c/i\u003e\u003c/span\u003e\u0026nbsp;\u003cspan class=\"feedback feedback-notice feedback-thin\"\u003eJivarus cohni\u003c/span\u003e"
  }
]
Type
array


/{id} get

GET: /taxon_names/{id}

Returns TaxonName instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples1

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/taxon_names/{id}?project_id=1&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/sources

See Overview at http://rdoc.taxonworks.org/Sources.html


/sources get

GET: /sources

Get all sources, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

author

Filter by author (inside author property). Matching is case insensitive. Use " " for "and". See also exact.

PropertyValue
requiredfalse
typestring
examplesRehn Hebard

ids[]

Filter by source IDs

PropertyValue
requiredfalse
typeinteger array

author_ids[]

Filter by author IDs

PropertyValue
requiredtrue
typestring

citation_object_type[]

Get source metadata associated with these types (Source::verbatim, Source::human, Source::Bibtex)

PropertyValue
requiredfalse
typestring

citations

Get source metadata associated with these citation IDs

PropertyValue
requiredfalse
typeinteger

documents

get sources matching documents

PropertyValue
requiredfalse
typestring boolean

exact_author

Metadata for only the exact author string provided (inside author property). Matching is case insensitive.

PropertyValue
requiredfalse
typestring

exact_title

Metadata selected for only exact title match

PropertyValue
requiredfalse
typestring boolean

identifier

Identifier associated with source

PropertyValue
requiredfalse
typestring

identifier_end

Last part of identifier associated with source

PropertyValue
requiredfalse
typestring

identifier_start

First part of identifier associated with source

PropertyValue
requiredfalse
typestring

identifier_exact

Exact identifier associated with source

PropertyValue
requiredfalse
typestring

in_project

Search only this project for the source metadata

PropertyValue
requiredfalse
typestring boolean
examplestrue

nomenclature

include nomenclature metadata

PropertyValue
requiredfalse
typestring boolean

notes

include notes metadata

PropertyValue
requiredfalse
typestring boolean

project_id

The project for the source search

PropertyValue
requiredtrue
typeinteger
examples2

recent

include metadata for recently accessed sources

PropertyValue
requiredfalse
typestring boolean

roles

include metadata for roles

PropertyValue
requiredfalse
typestring boolean
examplesfalse

source_type

type of source, e.g., Source::BibTex, Source::verbatim, Source::human

PropertyValue
requiredfalse
typestring

title

title of the source, e.g., "Studies in American Tettigoniidae"

PropertyValue
requiredfalse
typestring

keyword_ids[]

Get source metadata associated with these keyword IDs

PropertyValue
requiredfalse
typeinteger

topic_ids[]

Get source metadata associated with these topic IDs

PropertyValue
requiredfalse
typeinteger

with_doi

include metadata for sources having Digital Object Identifier

PropertyValue
requiredfalse
typestring boolean

user_date_end

Limit search to user dates prior

PropertyValue
requiredfalse
typestring

user_date_start

Limit search to user dates later

PropertyValue
requiredfalse
typestring

year_end

end year of the source date range

PropertyValue
requiredfalse
typeinteger

year_start

start year of the source date range

PropertyValue
requiredfalse
typeinteger

page

The page of sources result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of sources per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of sources in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of sources per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/sources get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/sources?author=Rehn Hebard&in_project=true&project_id=2&roles=false&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 3,
    "serial_id": 3312,
    "address": null,
    "annote": null,
    "author": "Rehn, James A. G. and Hebard, Morgan",
    "booktitle": null,
    "chapter": null,
    "crossref": null,
    "edition": null,
    "editor": null,
    "howpublished": null,
    "institution": null,
    "journal": "Transactions of the American Entomological Society",
    "key": null,
    "month": null,
    "note": null,
    "number": null,
    "organization": null,
    "pages": "271-344, Pl. IX-XII",
    "publisher": null,
    "school": null,
    "series": null,
    "title": "Studies in American Tettigoniidae, I and II, Scudderia and Amblycorypha",
    "type": "Source::Bibtex",
    "volume": "40",
    "doi": null,
    "abstract": null,
    "copyright": null,
    "language": null,
    "stated_year": null,
    "verbatim": null,
    "cached": "Rehn, J.A.G. &amp; Hebard, M. (1914) Studies in American Tettigoniidae, I and II, Scudderia and Amblycorypha. <i>Transactions of the American Entomological Society</i> 40, 271–344, Pl. IX-XII.",
    "cached_author_string": "Rehn & Hebard",
    "bibtex_type": "article",
    "created_by_id": 5,
    "updated_by_id": 24,
    "cached_nomenclature_date": "1914-12-31",
    "day": null,
    "year": 1914,
    "isbn": null,
    "issn": null,
    "verbatim_contents": null,
    "verbatim_keywords": null,
    "language_id": null,
    "translator": null,
    "year_suffix": null,
    "url": "http://chla.library.cornell.edu/c/chla/browse/title/5077659.html",
    "created_at": "2013-02-12T18:22:00.000Z",
    "updated_at": "2009-05-30T21:05:00.000Z",
    "object_tag": "Rehn, J.A.G. &amp; Hebard, M. (1914) Studies in American Tettigoniidae, I and II, Scudderia and Amblycorypha. <i>Transactions of the American Entomological Society</i> 40, 271–344, Pl. IX-XII.",
    "object_label": null,
    "global_id": "gid://taxon-works/Source::Bibtex/3",
    "base_class": "Source",
    "url_for": "http://localhost:3000/api/v1/sources",
    "object_url": "/sources/3",
    "source_in_project": false,
    "project_source_id": null,
    "author_roles": [
      {
        "id": 3,
        "position": 1,
        "type": "SourceAuthor",
        "person": {
          "id": 12,
          "type": "Person::Vetted",
          "last_name": "Rehn",
          "first_name": "James A. G.",
          "suffix": null,
          "prefix": null,
          "cached": "Rehn, James A. G.",
          "year_born": null,
          "year_died": null,
          "year_active_start": 1900,
          "year_active_end": 1964,
          "created_by_id": 5,
          "updated_by_id": 1,
          "created_at": "2013-02-12T18:22:00.000Z",
          "updated_at": "2019-11-11T19:51:35.008Z",
          "label_html": "Rehn, James A. G. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1900-1964</span> <span class=\"feedback feedback-thin feedback-primary\">1353 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author, Source</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
          "object_tag": "Rehn, James A. G.",
          "object_label": null,
          "global_id": "gid://taxon-works/Person::Vetted/12",
          "base_class": "Person",
          "url_for": "http://localhost:3000/api/v1/sources",
          "object_url": "/people/12"
        }
      },
      {
        "id": 4,
        "position": 2,
        "type": "SourceAuthor",
        "person": {
          "id": 15,
          "type": "Person::Vetted",
          "last_name": "Hebard",
          "first_name": "Morgan",
          "suffix": null,
          "prefix": null,
          "cached": "Hebard, Morgan",
          "year_born": null,
          "year_died": null,
          "year_active_start": 1905,
          "year_active_end": 1945,
          "created_by_id": 5,
          "updated_by_id": 1,
          "created_at": "2013-02-12T18:22:00.000Z",
          "updated_at": "2019-11-11T19:47:44.955Z",
          "label_html": "Hebard, Morgan <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1905-1945</span> <span class=\"feedback feedback-thin feedback-primary\">941 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
          "object_tag": "Hebard, Morgan",
          "object_label": null,
          "global_id": "gid://taxon-works/Person::Vetted/15",
          "base_class": "Person",
          "url_for": "http://localhost:3000/api/v1/sources",
          "object_url": "/people/15"
        }
      }
    ],
    "editor_roles": [],
    "documents": []
  }
]
Type
array


/{id} get

GET: /sources/{id}

Returns array of Sources metadata


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/sources/{id}?token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/people

See Overview at http://rdoc.taxonworks.org/People.html


/people get

GET: /people

Get all people, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

source_id

Source identifier for a single source.

PropertyValue
requiredfalse
typeinteger

first_name

Filter by person first name or fragment. Matching is case insensitive. Use " " for "and". See also exact.

PropertyValue
requiredfalse
typestring

last_name

Filter by person last name or fragment. Matching is case insensitive. Use " " for "and". See also exact.

PropertyValue
requiredfalse
typestring

last_name_starts_with

Filter by person last name fragment (from beginning). Matching is case insensitive. Use " " for "and". See also exact.

PropertyValue
requiredfalse
typestring
examplesMurp

limit_to_roles

Filter by person role(s), e.g., SourceAuthor, SourceEditor, SourceSource, TaxonNameAuthor. Matching is case insensitive. Use " " for "and". See also exact.

PropertyValue
requiredfalse
typestring
examplesSourceAuthor

project_id

The project for the source search

PropertyValue
requiredtrue
typeinteger
examples2

page

The page of people result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of people per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

Response Headers

Pagination-Total

Total number of people in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of people per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/people get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/people?last_name_starts_with=Murp&limit_to_roles=SourceAuthor&project_id=2&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 65,
    "type": "Person::Vetted",
    "last_name": "Murphy",
    "first_name": "D.H.",
    "suffix": null,
    "prefix": null,
    "cached": "Murphy, D.H.",
    "year_born": null,
    "year_died": null,
    "year_active_start": 1973,
    "year_active_end": 1973,
    "created_by_id": 5,
    "updated_by_id": 1,
    "created_at": "2013-02-12T18:22:00.000Z",
    "updated_at": "2019-11-11T20:02:56.194Z",
    "label_html": "Murphy, D.H. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1973-?</span> <span class=\"feedback feedback-thin feedback-primary\">2 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
    "object_tag": "Murphy, D.H.",
    "object_label": null,
    "global_id": "gid://taxon-works/Person::Vetted/65",
    "base_class": "Person",
    "url_for": "http://localhost:3000/api/v1/people",
    "object_url": "/people/65",
    "roles": [
      {
        "id": 16701,
        "person_id": 65,
        "role_object_id": 11202,
        "role_object_type": "Source",
        "position": 1,
        "created_by_id": 5,
        "updated_by_id": 24,
        "created_at": "2013-02-12T18:23:00.000Z",
        "updated_at": "2013-01-21T14:27:00.000Z",
        "role_object_tag": "Author of Murphy, D.H. (1973) A mangrove inhabiting cricket from peninsular Malaysia. <i>Malayan Nature Journal</i> 26, 171.",
        "global_id": "gid://taxon-works/SourceAuthor/16701",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      },
      {
        "id": 53123,
        "person_id": 65,
        "role_object_id": 37255,
        "role_object_type": "Source",
        "position": 1,
        "created_by_id": 24,
        "updated_by_id": 24,
        "created_at": "2014-11-20T08:13:00.000Z",
        "updated_at": "2014-11-20T08:13:00.000Z",
        "role_object_tag": "Author of Murphy, D.H. (1973) Guide to Genera of Malayan Blattodea, Gryllacridoidea and Tettigonioidea Department of Zoology, University of Singapore, 33 pp. pp.",
        "global_id": "gid://taxon-works/SourceAuthor/53123",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      }
    ]
  },
  {
    "id": 6731,
    "type": "Person::Vetted",
    "last_name": "Murphy",
    "first_name": "S.T.",
    "suffix": null,
    "prefix": null,
    "cached": "Murphy, S.T.",
    "year_born": null,
    "year_died": null,
    "year_active_start": 1999,
    "year_active_end": 1999,
    "created_by_id": 5,
    "updated_by_id": 1,
    "created_at": "2013-03-28T17:06:00.000Z",
    "updated_at": "2019-11-11T20:07:54.266Z",
    "label_html": "Murphy, S.T. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1999-?</span> <span class=\"feedback feedback-thin feedback-primary\">1 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
    "object_tag": "Murphy, S.T.",
    "object_label": null,
    "global_id": "gid://taxon-works/Person::Vetted/6731",
    "base_class": "Person",
    "url_for": "http://localhost:3000/api/v1/people",
    "object_url": "/people/6731",
    "roles": [
      {
        "id": 21818,
        "person_id": 6731,
        "role_object_id": 14569,
        "role_object_type": "Source",
        "position": 3,
        "created_by_id": 5,
        "updated_by_id": 10,
        "created_at": "2013-03-28T17:06:00.000Z",
        "updated_at": "2008-05-01T16:59:00.000Z",
        "role_object_tag": "Author of Watson, G.W., Voegtlin, D.J., Murphy, S.T. &amp; Foottit, R.G. (1999) Biogeography of the Cinara cupressi complex (Hemiptera: Aphididae) on Cupressaceae, with description of a pest species introduced into Africa. <i>Bulletin of Entomological Research</i> 89, 271–283.",
        "global_id": "gid://taxon-works/SourceAuthor/21818",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      }
    ]
  },
  {
    "id": 7087,
    "type": "Person::Vetted",
    "last_name": "Murphy",
    "first_name": "Troy G.",
    "suffix": null,
    "prefix": null,
    "cached": "Murphy, Troy G.",
    "year_born": null,
    "year_died": null,
    "year_active_start": 1999,
    "year_active_end": 1999,
    "created_by_id": 5,
    "updated_by_id": 1,
    "created_at": "2013-03-28T17:06:00.000Z",
    "updated_at": "2019-11-11T20:06:32.356Z",
    "label_html": "Murphy, Troy G. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1999-?</span> <span class=\"feedback feedback-thin feedback-primary\">1 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
    "object_tag": "Murphy, Troy G.",
    "object_label": null,
    "global_id": "gid://taxon-works/Person::Vetted/7087",
    "base_class": "Person",
    "url_for": "http://localhost:3000/api/v1/people",
    "object_url": "/people/7087",
    "roles": [
      {
        "id": 20416,
        "person_id": 7087,
        "role_object_id": 13675,
        "role_object_type": "Source",
        "position": 4,
        "created_by_id": 5,
        "updated_by_id": 404,
        "created_at": "2013-03-28T17:06:00.000Z",
        "updated_at": "2009-10-01T17:42:00.000Z",
        "role_object_tag": "Author of Moran, N.A., Kaplan, M.E., Gelsey, M.J., Murphy, T.G. &amp; Scholes, E.A. (1999) Phylogenetics and evolution of the aphid genus Uroleucon based on mitochondrial and nuclear DNA sequences. <i>Systematic Entomology</i> 24, 85–93.",
        "global_id": "gid://taxon-works/SourceAuthor/20416",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      }
    ]
  },
  {
    "id": 21015,
    "type": "Person::Vetted",
    "last_name": "Murphy",
    "first_name": "Megan A.",
    "suffix": null,
    "prefix": null,
    "cached": "Murphy, Megan A.",
    "year_born": null,
    "year_died": null,
    "year_active_start": 2016,
    "year_active_end": 2017,
    "created_by_id": 24,
    "updated_by_id": 1,
    "created_at": "2016-10-25T13:15:00.000Z",
    "updated_at": "2019-11-11T20:47:05.838Z",
    "label_html": "Murphy, Megan A. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 2016-2017</span> <span class=\"feedback feedback-thin feedback-primary\">2 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
    "object_tag": "Murphy, Megan A.",
    "object_label": null,
    "global_id": "gid://taxon-works/Person::Vetted/21015",
    "base_class": "Person",
    "url_for": "http://localhost:3000/api/v1/people",
    "object_url": "/people/21015",
    "roles": [
      {
        "id": 59504,
        "person_id": 21015,
        "role_object_id": 40697,
        "role_object_type": "Source",
        "position": 1,
        "created_by_id": 24,
        "updated_by_id": 24,
        "created_at": "2016-10-25T13:17:00.000Z",
        "updated_at": "2016-10-25T13:17:00.000Z",
        "role_object_tag": "Author of Murphy, M.A., Thompson, N.L. &amp; Schul, J. (2016) Keeping up with the neighbor: a novel mechanism of call synchrony in Neoconocephalus ensiger katydids. <i>Journal of Comparative Physiology A Sensory Neural and Behavioral Physiology</i> 202, 225–234.",
        "global_id": "gid://taxon-works/SourceAuthor/59504",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      },
      {
        "id": 61480,
        "person_id": 21015,
        "role_object_id": 41729,
        "role_object_type": "Source",
        "position": 1,
        "created_by_id": 24,
        "updated_by_id": 24,
        "created_at": "2017-06-05T12:04:00.000Z",
        "updated_at": "2017-06-05T12:04:00.000Z",
        "role_object_tag": "Author of Murphy, M.A. &amp; Schul, J. (2017) Does leadership indicate male quality in Neoconocephalus katydids? <i>Behavioral Ecology and Sociobiology</i> 71.",
        "global_id": "gid://taxon-works/SourceAuthor/61480",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      }
    ]
  },
  {
    "id": 24121,
    "type": "Person::Vetted",
    "last_name": "Murphey",
    "first_name": "Katherine J.",
    "suffix": null,
    "prefix": null,
    "cached": "Murphey, Katherine J.",
    "year_born": null,
    "year_died": null,
    "year_active_start": 2019,
    "year_active_end": 2019,
    "created_by_id": 24,
    "updated_by_id": 1,
    "created_at": "2019-10-03T09:02:00.000Z",
    "updated_at": "2019-11-11T20:54:53.409Z",
    "label_html": "Murphey, Katherine J. <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 2019-?</span> <span class=\"feedback feedback-thin feedback-primary\">1 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
    "object_tag": "Murphey, Katherine J.",
    "object_label": null,
    "global_id": "gid://taxon-works/Person::Vetted/24121",
    "base_class": "Person",
    "url_for": "http://localhost:3000/api/v1/people",
    "object_url": "/people/24121",
    "roles": [
      {
        "id": 69231,
        "person_id": 24121,
        "role_object_id": 45318,
        "role_object_type": "Source",
        "position": 2,
        "created_by_id": 24,
        "updated_by_id": 24,
        "created_at": "2019-10-03T09:05:00.000Z",
        "updated_at": "2019-10-03T09:05:00.000Z",
        "role_object_tag": "Author of Beckers, O.M., Murphey, K.J., Pease, J.R. &amp; Norman, N. (2019) Parallel plasticity of mating songs and preferences in the field cricket Gryllus rubens. <i>Ethology</i> 125, 476–484.",
        "global_id": "gid://taxon-works/SourceAuthor/69231",
        "type": "Role",
        "url": "http://localhost:3000/api/v1/people"
      }
    ]
  }
]
Type
array


/?last_name_starts_with get

GET: /people/?last_name_starts_with

returns array of people matching request parameters


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

/?last_name_starts_with get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/people/?last_name_starts_with?token=eUUB4dQCCWlLGzksimEqNQ" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/collection_objects

See Overview at http://rdoc.taxonworks.org/CollectionObjects.html


/collection_objects get

GET: /collection_objects

Get all collection_objects, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

collection_object_type

Type of collection object, e.g., "Specimen"

PropertyValue
requiredfalse
typestring

collecting_event_ids[]

List of IDs for associated collecting events.

PropertyValue
requiredfalse
typeinteger

geographic_area_ids[]

List of IDs for associated geographic areas.

PropertyValue
requiredfalse
typeinteger

recent

Include metadata for recent searches

PropertyValue
requiredfalse
typestring boolean
examplesfalse

otu_ids[]

Filter by OTU IDs

PropertyValue
requiredfalse
typeinteger

is_type

Include metadata for primary types

PropertyValue
requiredfalse
typestring boolean

otu_descendants

Include metadata for OTU decendants

PropertyValue
requiredfalse
typestring boolean
examplesfalse

ancestor_id

Include OTU ancestor in search

PropertyValue
requiredfalse
typeinteger

project_id

The project for the source search

PropertyValue
requiredtrue
typeinteger
examples2

current_determinations

Include metadata for current determinations

PropertyValue
requiredfalse
typestring boolean
examplesfalse

validity

Include metadata for valid (?)

PropertyValue
requiredfalse
typestring boolean

on_loan

Include metadata for onjects on loan

PropertyValue
requiredfalse
typestring boolean

loaned

Include metadata for loaned (borrowed) objects

PropertyValue
requiredfalse
typestring boolean
examplesfalse

never_loaned

Include metadata for objects

PropertyValue
requiredfalse
typestring boolean

biocuration_class_ids

Include metadata for biocuration classes by id

PropertyValue
requiredfalse
typestring boolean
examplesfalse

biological_relationship_ids[]

Include metadata biological relationships by id

PropertyValue
requiredfalse
typestring boolean
examplesfalse

depicted

Include metadata for depicted objects

PropertyValue
requiredfalse
typestring boolean
examplesfalse

end_date

Limit search to dates prior

PropertyValue
requiredfalse
typestring

start_date

Limit search to dates later

PropertyValue
requiredfalse
typestring

partial_overlap_dates

Allow date overlap

PropertyValue
requiredfalse
typestring boolean

user_date_end

Limit search to user dates prior

PropertyValue
requiredfalse
typestring

user_date_start

Limit search to user dates later

PropertyValue
requiredfalse
typestring

geo_json

geoJSON of the search area

PropertyValue
requiredfalse
typestring

radius

Radius around location

PropertyValue
requiredfalse
typestring

wkt

Well Known Text describing the search area

PropertyValue
requiredfalse
typestring

identifier

Identifier associated with collection object

PropertyValue
requiredfalse
typestring

identifier_end

Last part of identifier associated with collection object

PropertyValue
requiredfalse
typestring

identifier_start

First part of identifier associated with collection object

PropertyValue
requiredfalse
typestring

identifier_exact

Exact identifier associated with collection object

PropertyValue
requiredfalse
typestring

in_labels

Search in collection object labels

PropertyValue
requiredfalse
typestring boolean

in_verbatim_locality

Search in verbatim locality

PropertyValue
requiredfalse
typestring boolean

md5_verbatim_label

Match verbatim lable md5

PropertyValue
requiredfalse
typestring

namespace_id

Include metadata for a namespace by id

PropertyValue
requiredfalse
typeinteger

dwc_indexed

Include metadata for Darwin Core indexed events

PropertyValue
requiredfalse
typestring boolean

type_specimen_taxon_name_id

Include metadata for specific taxon by id

PropertyValue
requiredfalse
typeinteger

sled_image_id

Include metadata for SLED images by id

PropertyValue
requiredfalse
typeinteger

repository_id

Include metadata for repository by id

PropertyValue
requiredfalse
typeinteger

page

The page of collection_objects result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of collection_objects per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

Response Headers

Pagination-Total

Total number of collection_objects in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of collection_objects per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/collection_objects get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/collection_objects?recent=false&otu_descendants=false&project_id=2&current_determinations=false&loaned=false&biocuration_class_ids=false&biological_relationship_ids[]=false&depicted=false&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 1,
    "total": 1,
    "preparation_type_id": null,
    "collecting_event_id": 348,
    "repository_id": null,
    "type": "Specimen",
    "buffered_collecting_event": null,
    "buffered_determinations": null,
    "buffered_other_labels": null,
    "ranged_lot_category_id": null,
    "accessioned_at": null,
    "deaccessioned_at": null,
    "deaccession_reason": null,
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "created_at": "2013-02-12T18:32:00.000Z",
    "updated_at": "2017-11-23T07:50:00.000Z",
    "contained_in": null,
    "object_tag": "<span class=\"feedback feedback-thin feedback-primary\"><span title=\"Catalog number\">Depo collection_object.id 1 (SF.SpecimenID 40): SF.DepoID 43, 10463</span></span>&nbsp;det. <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"47045\">† <i>Bintoniella brodiei</i> Handlirsch, 1939</span> &#10003;</span>  on 2019-11-12&nbsp;[Spe]",
    "object_label": "CollectionObject 1, Depo collection_object.id 1 (SF.SpecimenID 40): SF.DepoID 43, 10463",
    "global_id": "gid://taxon-works/Specimen/1",
    "base_class": "CollectionObject",
    "url_for": "http://localhost:3000/api/v1/collection_objects",
    "object_url": "/collection_objects/1"
  },
  {
    "id": 2,
    "total": 1,
    "preparation_type_id": null,
    "collecting_event_id": 20814,
    "repository_id": null,
    "type": "Specimen",
    "buffered_collecting_event": null,
    "buffered_determinations": null,
    "buffered_other_labels": null,
    "ranged_lot_category_id": null,
    "accessioned_at": null,
    "deaccessioned_at": null,
    "deaccession_reason": null,
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "created_at": "2013-02-12T18:32:00.000Z",
    "updated_at": "2019-08-27T08:00:00.000Z",
    "contained_in": null,
    "object_tag": "<span class=\"feedback feedback-thin feedback-warning\">no identifier assigned</span>&nbsp;det. <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"33535\"><i>Hyalogryllacris munda munda</i> (Walker, 1869)</span> &#10003;</span>  on 2019-11-12&nbsp;[Spe]",
    "object_label": "CollectionObject 2",
    "global_id": "gid://taxon-works/Specimen/2",
    "base_class": "CollectionObject",
    "url_for": "http://localhost:3000/api/v1/collection_objects",
    "object_url": "/collection_objects/2"
  },
  {
    "id": 3,
    "total": 1,
    "preparation_type_id": null,
    "collecting_event_id": 20865,
    "repository_id": null,
    "type": "Specimen",
    "buffered_collecting_event": null,
    "buffered_determinations": null,
    "buffered_other_labels": null,
    "ranged_lot_category_id": null,
    "accessioned_at": null,
    "deaccessioned_at": null,
    "deaccession_reason": null,
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "created_at": "2013-02-12T18:32:00.000Z",
    "updated_at": "2016-11-30T13:03:00.000Z",
    "contained_in": null,
    "object_tag": "<span class=\"feedback feedback-thin feedback-warning\">no identifier assigned</span>&nbsp;det. <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"33529\"><i>Hyalogryllacris tumidula</i> (Karny, 1928)</span> &#10003;</span>  on 2019-11-12&nbsp;[Spe]",
    "object_label": "CollectionObject 3",
    "global_id": "gid://taxon-works/Specimen/3",
    "base_class": "CollectionObject",
    "url_for": "http://localhost:3000/api/v1/collection_objects",
    "object_url": "/collection_objects/3"
  },
  {
    "id": 4,
    "total": 3,
    "preparation_type_id": null,
    "collecting_event_id": 18732,
    "repository_id": null,
    "type": "Lot",
    "buffered_collecting_event": null,
    "buffered_determinations": null,
    "buffered_other_labels": null,
    "ranged_lot_category_id": null,
    "accessioned_at": null,
    "deaccessioned_at": null,
    "deaccession_reason": null,
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "created_at": "2013-02-12T18:32:00.000Z",
    "updated_at": "2018-01-11T13:34:00.000Z",
    "contained_in": null,
    "object_tag": "<span class=\"feedback feedback-thin feedback-warning\">no identifier assigned</span>&nbsp;det. <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"33528\"><i>Hyalogryllacris toxopei</i> (Karny, 1925)</span> &#10003;</span>  on 2019-11-12&nbsp;[Lot]",
    "object_label": "CollectionObject 4",
    "global_id": "gid://taxon-works/Lot/4",
    "base_class": "CollectionObject",
    "url_for": "http://localhost:3000/api/v1/collection_objects",
    "object_url": "/collection_objects/4"
  }
]
Type
array


/{id} get

GET: /collection_objects/{id}

Returns collection objects metadata for this ID


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/collection_objects/{id}?token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/identifers

See Overview at http://rdoc.taxonworks.org/Identifier.html


/identifers get

GET: /identifers

Get all identifers, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

identifier_object_id

Metadata for an ID of an object.

PropertyValue
requiredfalse
typeinteger

identifier_object_ids[]

Metadata for an array of IDs of objects identifier_object_ids[]=47&identifier_object_ids[]=2232.

PropertyValue
requiredfalse
typeinteger

identifier_object_type

Metadata for an object type.

PropertyValue
requiredfalse
typestring

identifier_object_types[]

Metadata for an array of object types. ?identifier_object_types[]=CollectionObject&identifier_object_types[]=Serial

PropertyValue
requiredfalse
typestring
examplesSerial

identifier

Include metadata for recent searches

PropertyValue
requiredfalse
typestring

type

Include metadata for a specific type, e.g, "Identifier::Local::CatalogNumber"

PropertyValue
requiredfalse
typestring

page

The page of identifers result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of identifers per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

Response Headers

Pagination-Total

Total number of identifers in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of identifers per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/identifers get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/identifers?identifier_object_types[]=Serial&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 18,
    "identifier_object_id": 1783,
    "identifier_object_type": "Serial",
    "identifier": "http://wnan.byu.edu/",
    "type": "Identifier::Global::Uri",
    "cached": "http://wnan.byu.edu/",
    "namespace_id": null,
    "created_by_id": 1,
    "updated_by_id": 1,
    "object_tag": "<span title=\"Uri\">http://wnan.byu.edu/</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/Identifier::Global::Uri/18",
    "base_class": "Identifier",
    "url_for": "http://localhost:3000/api/v1/identifiers",
    "object_url": "/identifiers/18",
    "identifier_object": {
      "object_tag": "Western North American Naturalist",
      "object_label": null,
      "global_id": "gid://taxon-works/Serial/1783",
      "base_class": "Serial",
      "url_for": "http://localhost:3000/api/v1/identifiers",
      "object_url": "/serials/1783"
    }
  },
  {
    "id": 20,
    "identifier_object_id": 1786,
    "identifier_object_type": "Serial",
    "identifier": "http://www.plosbiology.org/home.action",
    "type": "Identifier::Global::Uri",
    "cached": "http://www.plosbiology.org/home.action",
    "namespace_id": null,
    "created_by_id": 1,
    "updated_by_id": 1,
    "object_tag": "<span title=\"Uri\">http://www.plosbiology.org/home.action</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/Identifier::Global::Uri/20",
    "base_class": "Identifier",
    "url_for": "http://localhost:3000/api/v1/identifiers",
    "object_url": "/identifiers/20",
    "identifier_object": {
      "object_tag": "PLoS Biology",
      "object_label": null,
      "global_id": "gid://taxon-works/Serial/1786",
      "base_class": "Serial",
      "url_for": "http://localhost:3000/api/v1/identifiers",
      "object_url": "/serials/1786"
    }
  },
  {
    "id": 22,
    "identifier_object_id": 1789,
    "identifier_object_type": "Serial",
    "identifier": "http://www.jse.ac.cn/",
    "type": "Identifier::Global::Uri",
    "cached": "http://www.jse.ac.cn/",
    "namespace_id": null,
    "created_by_id": 1,
    "updated_by_id": 1,
    "object_tag": "<span title=\"Uri\">http://www.jse.ac.cn/</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/Identifier::Global::Uri/22",
    "base_class": "Identifier",
    "url_for": "http://localhost:3000/api/v1/identifiers",
    "object_url": "/identifiers/22",
    "identifier_object": {
      "object_tag": "Journal of Systematics and Evolution",
      "object_label": null,
      "global_id": "gid://taxon-works/Serial/1789",
      "base_class": "Serial",
      "url_for": "http://localhost:3000/api/v1/identifiers",
      "object_url": "/serials/1789"
    }
  },
  {
    "id": 24,
    "identifier_object_id": 1790,
    "identifier_object_type": "Serial",
    "identifier": "http://www.biotechniques.com/",
    "type": "Identifier::Global::Uri",
    "cached": "http://www.biotechniques.com/",
    "namespace_id": null,
    "created_by_id": 1,
    "updated_by_id": 1,
    "object_tag": "<span title=\"Uri\">http://www.biotechniques.com/</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/Identifier::Global::Uri/24",
    "base_class": "Identifier",
    "url_for": "http://localhost:3000/api/v1/identifiers",
    "object_url": "/identifiers/24",
    "identifier_object": {
      "object_tag": "Biotechniques",
      "object_label": null,
      "global_id": "gid://taxon-works/Serial/1790",
      "base_class": "Serial",
      "url_for": "http://localhost:3000/api/v1/identifiers",
      "object_url": "/serials/1790"
    }
  },
  {
    "id": 31,
    "identifier_object_id": 2910,
    "identifier_object_type": "Serial",
    "identifier": "http://rsmas.miami.edu/bms/",
    "type": "Identifier::Global::Uri",
    "cached": "http://rsmas.miami.edu/bms/",
    "namespace_id": null,
    "created_by_id": 1,
    "updated_by_id": 1,
    "object_tag": "<span title=\"Uri\">http://rsmas.miami.edu/bms/</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/Identifier::Global::Uri/31",
    "base_class": "Identifier",
    "url_for": "http://localhost:3000/api/v1/identifiers",
    "object_url": "/identifiers/31",
    "identifier_object": {
      "object_tag": "Bulletin of Marine Science",
      "object_label": null,
      "global_id": "gid://taxon-works/Serial/2910",
      "base_class": "Serial",
      "url_for": "http://localhost:3000/api/v1/identifiers",
      "object_url": "/serials/2910"
    }
  }
]
Type
array

/collecting_events

See Overview at http://rdoc.taxonworks.org/CollectingEvent.html


/collecting_events get

GET: /collecting_events

Get all collecting_events, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

keyword_ids[]

List of keyword IDs for associated collecting events.

PropertyValue
requiredfalse
typeinteger

recent

PropertyValue
requiredfalse
typestring boolean

in_labels

Wildcard wrapped match against any label

PropertyValue
requiredfalse
typestring

in_verbatim_locality

Wildcard wrapped match against verbatim locality (via ATTRIBUTES)

PropertyValue
requiredfalse
typestring

spatial_geographic_areas

Reference geographic areas in a spatial query

PropertyValue
requiredfalse
typestring boolean

geographic_area_ids[]

List of geographic area IDs for search

PropertyValue
requiredfalse
typeinteger

collecting_events_wildcards[]

ATTRIBUTES that should be wildcarded

PropertyValue
requiredfalse
typestring array

otu_ids[]

List of OTU IDs

PropertyValue
requiredfalse
typeinteger array

page

The page of collecting_events result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of collecting_events per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

Response Headers

Pagination-Total

Total number of collecting_events in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of collecting_events per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/collecting_events get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/collecting_events?page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 9,
    "verbatim_label": null,
    "print_label": null,
    "document_label": null,
    "verbatim_locality": "Departamento Concepción, Santa María",
    "verbatim_longitude": "-55.355878",
    "verbatim_latitude": "-27.895639",
    "verbatim_geolocation_uncertainty": null,
    "verbatim_trip_identifier": null,
    "verbatim_collectors": "M.J.Viana",
    "verbatim_method": null,
    "verbatim_elevation": null,
    "verbatim_habitat": null,
    "verbatim_datum": null,
    "verbatim_date": null,
    "geographic_area_id": null,
    "minimum_elevation": null,
    "maximum_elevation": null,
    "elevation_precision": null,
    "start_date_day": 9,
    "start_date_month": 11,
    "start_date_year": 1962,
    "end_date_day": null,
    "end_date_month": null,
    "end_date_year": null,
    "time_start_hour": null,
    "time_start_minute": null,
    "time_start_second": null,
    "time_end_hour": null,
    "time_end_minute": null,
    "time_end_second": null,
    "field_notes": null,
    "md5_of_verbatim_label": null,
    "min_ma": null,
    "max_ma": null,
    "cached": null,
    "cached_level0_geographic_name": null,
    "cached_level1_geographic_name": null,
    "cached_level2_geographic_name": null,
    "group": null,
    "formation": null,
    "member": null,
    "lithology": null,
    "identifiers": [],
    "created_by_id": 1,
    "updated_by_id": 1,
    "project_id": 2,
    "created_at": "2019-11-12T10:00:56.782Z",
    "updated_at": "2019-11-12T10:00:56.782Z",
    "object_tag": "<span>Departamento Concepción, Santa María</span>; <span>1962/11/09</span>; &nbsp;<span class=\"feedback feedback-thin feedback-secondary\">M.J.Viana</span>; <span>-55.3559&nbsp;&#8212;&nbsp;-27.8956</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/CollectingEvent/9",
    "base_class": "CollectingEvent",
    "url_for": "http://localhost:3000/api/v1/collecting_events",
    "object_url": "/collecting_events/9"
  },
  {
  "id": 10,
  "verbatim_label": null,
  "print_label": null,
  "document_label": null,
  "verbatim_locality": "(A 10 Km de Pozo Azul hacia San Pedro)",
  "verbatim_longitude": "-54.137306",
  "verbatim_latitude": "-26.448556",
  "verbatim_geolocation_uncertainty": null,
  "verbatim_trip_identifier": null,
  "verbatim_collectors": "Cigliano & Lange",
  "verbatim_method": null,
  "verbatim_elevation": null,
  "verbatim_habitat": null,
  "verbatim_datum": null,
  "verbatim_date": null,
  "geographic_area_id": null,
  "minimum_elevation": null,
  "maximum_elevation": null,
  "elevation_precision": null,
  "start_date_day": 8,
  "start_date_month": 12,
  "start_date_year": 2010,
  "end_date_day": null,
  "end_date_month": null,
  "end_date_year": null,
  "time_start_hour": null,
  "time_start_minute": null,
  "time_start_second": null,
  "time_end_hour": null,
  "time_end_minute": null,
  "time_end_second": null,
  "field_notes": null,
  "md5_of_verbatim_label": null,
  "min_ma": null,
  "max_ma": null,
  "cached": null,
  "cached_level0_geographic_name": null,
  "cached_level1_geographic_name": null,
  "cached_level2_geographic_name": null,
  "group": null,
  "formation": null,
  "member": null,
  "lithology": null,
  "identifiers": [],
  "created_by_id": 1,
  "updated_by_id": 1,
  "project_id": 2,
  "created_at": "2019-11-12T10:00:56.816Z",
  "updated_at": "2019-11-12T10:00:56.816Z",
  "object_tag": "<span>(A 10 Km de Pozo Azul hacia San Pedro)</span>; <span>2010/12/08</span>; &nbsp;<span class=\"feedback feedback-thin feedback-secondary\">Cigliano &amp; Lange</span>; <span>-54.1373&nbsp;&#8212;&nbsp;-26.4486</span>",
  "object_label": null,
  "global_id": "gid://taxon-works/CollectingEvent/10",
  "base_class": "CollectingEvent",
  "url_for": "http://localhost:3000/api/v1/collecting_events",
  "object_url": "/collecting_events/10"
  }
]
Type
array

/biological_associations

See Overview at http://rdoc.taxonworks.org/BiologicalAssociations.html


/biological_associations get

GET: /biological_associations

Get all biological_associations, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

biological_relationship_id

Identifier for the relationship.

PropertyValue
requiredfalse
typeinteger
examples1

biological_association_subject_type

Subject part of the association triple

PropertyValue
requiredfalse
typestring
examplesOtu

biological_association_object_type

Object part of the association triple

PropertyValue
requiredfalse
typestring
examplesOtu

subject_global_id

Identifier for the subject.

PropertyValue
requiredfalse
typestring
examplesgid://taxon-works/Otu/23068

object_global_id

Identifier for the object.

PropertyValue
requiredfalse
typestring
examplesgid://taxon-works/Otu/130025

any_global_id

Any global identifier for the relationship.

PropertyValue
requiredfalse
typestring

page

The page of biological_associations result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of biological_associations per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of biological_associations in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of biological_associations per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/biological_associations get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/biological_associations?biological_relationship_id=1&biological_association_subject_type=Otu&biological_association_object_type=Otu&subject_global_id=gid://taxon-works/Otu/23068&object_global_id=gid://taxon-works/Otu/130025&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 1,
    "biological_relationship_id": 1,
    "biological_association_subject_id": 23068,
    "biological_association_subject_type": "Otu",
    "biological_association_object_id": 130025,
    "biological_association_object_type": "Otu",
    "created_by_id": 1623,
    "updated_by_id": 1623,
    "project_id": 2,
    "created_at": "2020-10-01T17:31:13.678Z",
    "updated_at": "2020-10-01T17:31:13.678Z",
    "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"23093\"><i>Gryllus</i> Linnaeus, 1758</span> &#10003;</span> <span class=\"notice\">predator / prey</span> <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"174030\"><i>Plesiotettix sagittum</i> Silva & Cadena-Castañeda, 2020</span> &#10060;</span>",
    "object_label": null,
    "global_id": "gid://taxon-works/BiologicalAssociation/1",
    "base_class": "BiologicalAssociation",
    "url_for": "http://localhost:3000/api/v1/biological_associations",
    "object_url": "/biological_associations/1",
    "subject_global_id": "gid://taxon-works/Otu/23068",
    "object_global_id": "gid://taxon-works/Otu/130025",
    "biological_relationship": {
      "id": 1,
      "name": "predator",
      "inverted_name": "prey",
      "is_transitive": true,
      "is_reflexive": true,
      "created_by_id": 1623,
      "updated_by_id": 1623,
      "project_id": 2,
      "created_at": "2020-10-01T17:14:34.953Z",
      "updated_at": "2020-10-01T17:14:34.953Z",
      "object_tag": "predator / prey",
      "object_label": null,
      "global_id": "gid://taxon-works/BiologicalRelationship/1",
      "base_class": "BiologicalRelationship",
      "url_for": "http://localhost:3000/api/v1/biological_associations",
      "object_url": "/biological_relationships/1",
      "subject_biological_relationship_types": [],
      "object_biological_relationship_types": []
    },
    "citations": [],
    "subject": {
      "id": 23068,
      "name": null,
      "taxon_name_id": 23093,
      "created_by_id": 5,
      "updated_by_id": 5,
      "project_id": 2,
      "created_at": "2020-09-17T02:58:17.420Z",
      "updated_at": "2020-09-17T02:58:17.420Z",
      "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"23093\"><i>Gryllus</i> Linnaeus, 1758</span> &#10003;</span>",
      "object_label": "Gryllus Linnaeus, 1758",
      "global_id": "gid://taxon-works/Otu/23068",
      "base_class": "Otu",
      "url_for": "http://localhost:3000/api/v1/biological_associations",
      "object_url": "/otus/23068"
    },
    "object": {
      "id": 130025,
      "name": null,
      "taxon_name_id": 174030,
      "created_by_id": 1,
      "updated_by_id": 1,
      "project_id": 2,
      "created_at": "2020-09-28T19:00:18.147Z",
      "updated_at": "2020-09-28T19:00:18.147Z",
      "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"174030\"><i>Plesiotettix sagittum</i> Silva & Cadena-Castañeda, 2020</span> &#10060;</span>",
      "object_label": "Plesiotettix sagittum Silva & Cadena-Castañeda, 2020",
      "global_id": "gid://taxon-works/Otu/130025",
      "base_class": "Otu",
      "url_for": "http://localhost:3000/api/v1/biological_associations",
      "object_url": "/otus/130025"
    }
  }
]
Type
array


/{id} get

GET: /biological_associations/{id}

Returns BiologicalAssociations instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples2

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/biological_associations/{id}?project_id=2&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/citations

See Overview at http://rdoc.taxonworks.org/Citations.html


/citations get

GET: /citations

Get all citations, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

source_id

Identifier for the citation's source.

PropertyValue
requiredfalse
typeinteger
examples1

citation_object_type

object type for the citation, such as TaxonDetermination, TaxonName, etc.

PropertyValue
requiredfalse
typestring
examplesTaxonName

citation_object_id

Identifier for the citation object.

PropertyValue
requiredfalse
typeinteger
examples42463

is_original

Is the citation of the original description.

PropertyValue
requiredfalse
typestring boolean
examplesfalse

page

The page of citations result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of citations per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of citations in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of citations per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/citations get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/citations?source_id=1&citation_object_type=TaxonName&citation_object_id=42463&is_original=false&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 216868,
    "citation_object_id": 42463,
    "citation_object_type": "TaxonName",
    "source_id": 1,
    "pages": "287",
    "is_original": false,
    "created_by_id": 5,
    "updated_by_id": 24,
    "project_id": 2,
    "object_tag": "Protonym: <i>Microcentrum</i> in Caudell, 1907:287",
    "object_label": null,
    "global_id": "gid://taxon-works/Citation/216868",
    "base_class": "Citation",
    "url_for": "http://localhost:3000/api/v1/citations",
    "object_url": "/citations/216868",
    "citation_object": {
      "object_tag": "<i>Microcentrum</i>",
      "object_label": "Microcentrum Scudder, 1862",
      "global_id": "gid://taxon-works/Protonym/42463",
      "base_class": "TaxonName",
      "url_for": "http://localhost:3000/api/v1/citations",
      "object_url": "/taxon_names/42463",
      "origin_citation": {
        "id": 42068,
        "pages": "446",
        "object_tag": "Protonym: <i>Microcentrum</i> in Scudder, 1862:446",
        "object_label": null,
        "global_id": "gid://taxon-works/Citation/42068",
        "base_class": "Citation",
        "url_for": "http://localhost:3000/api/v1/citations",
        "object_url": "/citations/42068",
        "source": {
          "id": 7428,
          "serial_id": 7603,
          "address": null,
          "annote": null,
          "author": "Scudder, Samuel Hubbard",
          "booktitle": null,
          "chapter": null,
          "crossref": null,
          "edition": null,
          "editor": null,
          "howpublished": null,
          "institution": null,
          "journal": "Boston Journal of Natural History",
          "key": null,
          "month": null,
          "note": null,
          "number": "3",
          "organization": null,
          "pages": "409-480",
          "publisher": null,
          "school": null,
          "series": null,
          "title": "Materials for a monograph of the North American Orthoptera including a catalogue of the known New England species",
          "type": "Source::Bibtex",
          "volume": "7",
          "doi": null,
          "abstract": null,
          "copyright": null,
          "language": null,
          "stated_year": null,
          "verbatim": null,
          "cached": "Scudder, S.H. (1862) Materials for a monograph of the North American Orthoptera including a catalogue of the known New England species. <i>Boston Journal of Natural History</i> 7, 409–480.",
          "cached_author_string": "Scudder",
          "bibtex_type": "article",
          "created_by_id": 5,
          "updated_by_id": 24,
          "cached_nomenclature_date": "1862-12-31",
          "day": null,
          "year": 1862,
          "isbn": null,
          "issn": null,
          "verbatim_contents": null,
          "verbatim_keywords": null,
          "language_id": null,
          "translator": null,
          "year_suffix": null,
          "url": "http://www.archive.org/details/materialsformono00scudrich",
          "created_at": "2013-02-12T18:22:00.000Z",
          "updated_at": "2009-09-29T08:50:00.000Z",
          "object_tag": "Scudder, S.H. (1862) Materials for a monograph of the North American Orthoptera including a catalogue of the known New England species. <i>Boston Journal of Natural History</i> 7, 409–480.",
          "object_label": null,
          "global_id": "gid://taxon-works/Source::Bibtex/7428",
          "base_class": "Source",
          "url_for": "http://localhost:3000/api/v1/citations",
          "object_url": "/sources/7428",
          "source_in_project": true,
          "project_source_id": 7428,
          "author_roles": [
            {
              "id": 9134,
              "position": 1,
              "type": "SourceAuthor",
              "person": {
                "id": 49,
                "type": "Person::Vetted",
                "last_name": "Scudder",
                "first_name": "Samuel Hubbard",
                "suffix": null,
                "prefix": null,
                "cached": "Scudder, Samuel Hubbard",
                "year_born": null,
                "year_died": null,
                "year_active_start": 1861,
                "year_active_end": 1902,
                "created_by_id": 5,
                "updated_by_id": 1,
                "created_at": "2013-02-12T18:22:00.000Z",
                "updated_at": "2020-09-17T01:42:03.822Z",
                "label_html": "Scudder, Samuel Hubbard <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1861-1902</span> <span class=\"feedback feedback-thin feedback-primary\">918 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
                "object_tag": "Scudder, Samuel Hubbard",
                "object_label": null,
                "global_id": "gid://taxon-works/Person::Vetted/49",
                "base_class": "Person",
                "url_for": "http://localhost:3000/api/v1/citations",
                "object_url": "/people/49"
              }
            }
          ],
          "editor_roles": [],
          "documents": []
        }
      }
    },
    "citation_topics": [],
    "citation_source_body": "Caudell, 1907:287",
    "source": {
      "id": 1,
      "serial_id": 4845,
      "address": null,
      "annote": null,
      "author": "Caudell, Andrew Nelson",
      "booktitle": null,
      "chapter": null,
      "crossref": null,
      "edition": null,
      "editor": null,
      "howpublished": null,
      "institution": null,
      "journal": "The Canadian Entomologist",
      "key": null,
      "month": null,
      "note": null,
      "number": "8",
      "organization": null,
      "pages": "287-292",
      "publisher": null,
      "school": null,
      "series": null,
      "title": "Book Notice: Kirby's Catalogue of Orthoptera. Vol. II",
      "type": "Source::Bibtex",
      "volume": "39",
      "doi": null,
      "abstract": null,
      "copyright": null,
      "language": null,
      "stated_year": null,
      "verbatim": null,
      "cached": "Caudell, A.N. (1907) Book Notice: Kirby's Catalogue of Orthoptera. Vol. II. <i>The Canadian Entomologist</i> 39, 287–292.",
      "cached_author_string": "Caudell",
      "bibtex_type": "article",
      "created_by_id": 5,
      "updated_by_id": 24,
      "cached_nomenclature_date": "1907-12-31",
      "day": null,
      "year": 1907,
      "isbn": null,
      "issn": null,
      "verbatim_contents": null,
      "verbatim_keywords": null,
      "language_id": null,
      "translator": null,
      "year_suffix": null,
      "url": "http://www.biodiversitylibrary.org/item/88663#page/311/mode/1up",
      "created_at": "2013-02-12T18:22:00.000Z",
      "updated_at": "2013-06-11T09:05:00.000Z",
      "object_tag": "Caudell, A.N. (1907) Book Notice: Kirby's Catalogue of Orthoptera. Vol. II. <i>The Canadian Entomologist</i> 39, 287–292.",
      "object_label": null,
      "global_id": "gid://taxon-works/Source::Bibtex/1",
      "base_class": "Source",
      "url_for": "http://localhost:3000/api/v1/citations",
      "object_url": "/sources/1",
      "source_in_project": true,
      "project_source_id": 1,
      "author_roles": [
        {
          "id": 1,
          "position": 1,
          "type": "SourceAuthor",
          "person": {
            "id": 6,
            "type": "Person::Vetted",
            "last_name": "Caudell",
            "first_name": "Andrew Nelson",
            "suffix": null,
            "prefix": null,
            "cached": "Caudell, Andrew Nelson",
            "year_born": null,
            "year_died": null,
            "year_active_start": 1901,
            "year_active_end": 1936,
            "created_by_id": 5,
            "updated_by_id": 1,
            "created_at": "2013-02-12T18:22:00.000Z",
            "updated_at": "2020-09-17T01:41:41.931Z",
            "label_html": "Caudell, Andrew Nelson <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1901-1936</span> <span class=\"feedback feedback-thin feedback-primary\">277 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
            "object_tag": "Caudell, Andrew Nelson",
            "object_label": null,
            "global_id": "gid://taxon-works/Person::Vetted/6",
            "base_class": "Person",
            "url_for": "http://localhost:3000/api/v1/citations",
            "object_url": "/people/6"
          }
        }
      ],
      "editor_roles": [],
      "documents": [],
      "author_year": "Caudell, 1907"
    }
  },
  {
    "id": 209442,
    "citation_object_id": 119992,
    "citation_object_type": "TaxonName",
    "source_id": 2,
    "pages": "202",
    "is_original": false,
    "created_by_id": 5,
    "updated_by_id": 7,
    "project_id": 2,
    "object_tag": "Combination: <i>Bulla</i> in Karny, 1908:202",
    "object_label": null,
    "global_id": "gid://taxon-works/Citation/209442",
    "base_class": "Citation",
    "url_for": "http://localhost:3000/api/v1/citations",
    "object_url": "/citations/209442",
    "citation_object": {
      "object_tag": "<i>Bulla</i>",
      "object_label": "Bulla Linnaeus, 1758",
      "global_id": "gid://taxon-works/Combination/119992",
      "base_class": "TaxonName",
      "url_for": "http://localhost:3000/api/v1/citations",
      "object_url": "/taxon_names/119992"
    },
    "citation_topics": [],
    "citation_source_body": "Karny, 1908:202",
    "source": {
      "id": 2,
      "serial_id": 1514,
      "address": null,
      "annote": null,
      "author": "Karny, Heinrich Hugo",
      "booktitle": null,
      "chapter": null,
      "crossref": null,
      "edition": null,
      "editor": null,
      "howpublished": null,
      "institution": null,
      "journal": "Zoologische Annalen",
      "key": null,
      "month": null,
      "note": null,
      "number": null,
      "organization": null,
      "pages": "202-208",
      "publisher": null,
      "school": null,
      "series": null,
      "title": "Bemerkungen zu dem Linné'schen Gattungsnamen \"Tettigonia\"",
      "type": "Source::Bibtex",
      "volume": "2",
      "doi": null,
      "abstract": null,
      "copyright": null,
      "language": null,
      "stated_year": null,
      "verbatim": null,
      "cached": "Karny, H.H. (1908) Bemerkungen zu dem Linné'schen Gattungsnamen \"Tettigonia\". <i>Zoologische Annalen</i> 2, 202–208.",
      "cached_author_string": "Karny",
      "bibtex_type": "article",
      "created_by_id": 5,
      "updated_by_id": 24,
      "cached_nomenclature_date": "1908-12-31",
      "day": null,
      "year": 1908,
      "isbn": null,
      "issn": null,
      "verbatim_contents": null,
      "verbatim_keywords": null,
      "language_id": null,
      "translator": null,
      "year_suffix": null,
      "url": "http://www.biodiversitylibrary.org/item/109156#page/218/mode/1up",
      "created_at": "2013-02-12T18:22:00.000Z",
      "updated_at": "2017-07-22T15:32:00.000Z",
      "object_tag": "Karny, H.H. (1908) Bemerkungen zu dem Linné'schen Gattungsnamen \"Tettigonia\". <i>Zoologische Annalen</i> 2, 202–208.",
      "object_label": null,
      "global_id": "gid://taxon-works/Source::Bibtex/2",
      "base_class": "Source",
      "url_for": "http://localhost:3000/api/v1/citations",
      "object_url": "/sources/2",
      "source_in_project": true,
      "project_source_id": 2,
      "author_roles": [
        {
          "id": 2,
          "position": 1,
          "type": "SourceAuthor",
          "person": {
            "id": 7,
            "type": "Person::Vetted",
            "last_name": "Karny",
            "first_name": "Heinrich Hugo",
            "suffix": null,
            "prefix": null,
            "cached": "Karny, Heinrich Hugo",
            "year_born": null,
            "year_died": null,
            "year_active_start": 1907,
            "year_active_end": 1937,
            "created_by_id": 5,
            "updated_by_id": 1,
            "created_at": "2013-02-12T18:22:00.000Z",
            "updated_at": "2020-09-17T01:37:32.403Z",
            "label_html": "Karny, Heinrich Hugo <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1907-1937</span> <span class=\"feedback feedback-thin feedback-primary\">1246 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
            "object_tag": "Karny, Heinrich Hugo",
            "object_label": null,
            "global_id": "gid://taxon-works/Person::Vetted/7",
            "base_class": "Person",
            "url_for": "http://localhost:3000/api/v1/citations",
            "object_url": "/people/7"
          }
        }
      ],
      "editor_roles": [],
      "documents": [],
      "author_year": "Karny, 1908"
    }
  }
]
Type
array


/{id} get

GET: /citations/{id}

Returns Citations instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples4

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/citations/{id}?project_id=4&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/asserted_distributions

See Overview at http://rdoc.taxonworks.org/AssertedDistribution.html


/asserted_distributions get

GET: /asserted_distributions

Get all asserted_distributions, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

recent

Include recent searchs?.

PropertyValue
requiredfalse
typestring boolean
examplesfalse

geographic_area_id

Identifier for the geographic area.

PropertyValue
requiredfalse
typeinteger
examples33609

otu_id

Identifier for the otu for which the distribution is asserted.

PropertyValue
requiredfalse
typeinteger
examples24061

page

The page of asserted_distributions result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of asserted_distributions per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of asserted_distributions in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of asserted_distributions per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/asserted_distributions get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/asserted_distributions?recent=false&geographic_area_id=33609&otu_id=24061&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

[
  {
    "id": 4,
    "otu_id": 24061,
    "geographic_area_id": 33609,
    "project_id": 2,
    "created_by_id": 1,
    "updated_by_id": 1,
    "is_absent": null,
    "created_at": "2020-09-28T17:20:43.865Z",
    "updated_at": "2020-09-28T17:20:43.865Z",
    "origin_citation_source_id": null,
    "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"24085\"><i>Modicogryllus</i> (<i>Modicogryllus</i>) <i>algirius algirius</i> (Saussure, 1877)</span> &#10003;</span>&nbsp; in &nbsp;Algeria",
    "object_label": null,
    "global_id": "gid://taxon-works/AssertedDistribution/4",
    "base_class": "AssertedDistribution",
    "url_for": "http://localhost:3000/api/v1/asserted_distributions",
    "object_url": "/asserted_distributions/4",
    "citations": [
      {
        "id": 655238,
        "citation_object_id": 4,
        "citation_object_type": "AssertedDistribution",
        "source_id": 59,
        "pages": null,
        "is_original": null,
        "created_by_id": 1,
        "updated_by_id": 1,
        "project_id": 2,
        "object_tag": "AssertedDistribution: <span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"24085\"><i>Modicogryllus</i> (<i>Modicogryllus</i>) <i>algirius algirius</i> (Saussure, 1877)</span> &#10003;</span>&nbsp; in &nbsp;Algeria in Brunner von Wattenwyl, 1882",
        "object_label": null,
        "global_id": "gid://taxon-works/Citation/655238",
        "base_class": "Citation",
        "url_for": "http://localhost:3000/api/v1/asserted_distributions",
        "object_url": "/citations/655238",
        "citation_object": {
          "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"24085\"><i>Modicogryllus</i> (<i>Modicogryllus</i>) <i>algirius algirius</i> (Saussure, 1877)</span> &#10003;</span>&nbsp; in &nbsp;Algeria",
          "object_label": null,
          "global_id": "gid://taxon-works/AssertedDistribution/4",
          "base_class": "AssertedDistribution",
          "url_for": "http://localhost:3000/api/v1/asserted_distributions",
          "object_url": "/asserted_distributions/4"
        },
        "citation_topics": [],
        "citation_source_body": "Brunner von Wattenwyl, 1882",
        "source": {
          "id": 59,
          "serial_id": null,
          "address": "Leipzig",
          "annote": null,
          "author": "Brunner von Wattenwyl, Carl",
          "booktitle": "Prodromus der europäischen Orthopteren",
          "chapter": null,
          "crossref": null,
          "edition": null,
          "editor": null,
          "howpublished": null,
          "institution": null,
          "journal": null,
          "key": null,
          "month": null,
          "note": null,
          "number": null,
          "organization": null,
          "pages": "XXXII + 466 pp., XI tab.",
          "publisher": "Engelmann",
          "school": null,
          "series": null,
          "title": null,
          "type": "Source::Bibtex",
          "volume": null,
          "doi": null,
          "abstract": null,
          "copyright": null,
          "language": null,
          "stated_year": null,
          "verbatim": null,
          "cached": "Wattenwyl, C. Brunner von (1882) Prodromus der europäischen Orthopteren Engelmann, Leipzig. Available from: http://www.zobodat.at/publikation_volumes.php?id=35024 XXXII + 466 pp., XI tab.",
          "cached_author_string": "Brunner von Wattenwyl",
          "bibtex_type": "book",
          "created_by_id": 5,
          "updated_by_id": 238,
          "cached_nomenclature_date": "1882-12-31",
          "day": null,
          "year": 1882,
          "isbn": null,
          "issn": null,
          "verbatim_contents": null,
          "verbatim_keywords": null,
          "language_id": null,
          "translator": null,
          "year_suffix": null,
          "url": "http://www.zobodat.at/publikation_volumes.php?id=35024",
          "created_at": "2013-02-12T18:22:00.000Z",
          "updated_at": "2020-01-13T08:20:00.000Z",
          "object_tag": "Wattenwyl, C. Brunner von (1882) Prodromus der europäischen Orthopteren Engelmann, Leipzig. Available from: http://www.zobodat.at/publikation_volumes.php?id=35024 XXXII + 466 pp., XI tab.",
          "object_label": null,
          "global_id": "gid://taxon-works/Source::Bibtex/59",
          "base_class": "Source",
          "url_for": "http://localhost:3000/api/v1/asserted_distributions",
          "object_url": "/sources/59",
          "source_in_project": true,
          "project_source_id": 59,
          "author_roles": [
            {
              "id": 69,
              "position": 1,
              "type": "SourceAuthor",
              "person": {
                "id": 5,
                "type": "Person::Vetted",
                "last_name": "Brunner von Wattenwyl",
                "first_name": "Carl",
                "suffix": null,
                "prefix": null,
                "cached": "Brunner von Wattenwyl, Carl",
                "year_born": null,
                "year_died": null,
                "year_active_start": 1861,
                "year_active_end": 1906,
                "created_by_id": 5,
                "updated_by_id": 1,
                "created_at": "2013-02-12T18:22:00.000Z",
                "updated_at": "2020-09-17T01:38:42.619Z",
                "label_html": "Brunner von Wattenwyl, Carl <span class=\"feedback feedback-secondary feedback-thin\">lived: ?-? active ~ 1861-1906</span> <span class=\"feedback feedback-thin feedback-primary\">1711 uses</span> <span class=\"feedback feedback-thin feedback-secondary\">Author, Taxon name author</span> <span class=\"feedback feedback-thin feedback-success\">In&nbsp;Project</span>",
                "object_tag": "Brunner von Wattenwyl, Carl",
                "object_label": null,
                "global_id": "gid://taxon-works/Person::Vetted/5",
                "base_class": "Person",
                "url_for": "http://localhost:3000/api/v1/asserted_distributions",
                "object_url": "/people/5"
              }
            }
          ],
          "editor_roles": [],
          "documents": [],
          "author_year": "Brunner von Wattenwyl, 1882"
        }
      }
    ],
    "otu": {
      "id": 24061,
      "name": null,
      "taxon_name_id": 24085,
      "created_by_id": 5,
      "updated_by_id": 5,
      "project_id": 2,
      "created_at": "2020-09-17T02:59:58.121Z",
      "updated_at": "2020-09-17T02:59:58.121Z",
      "object_tag": "<span class=\"otu_tag\"><span class=\"otu_tag_taxon_name\" title=\"24085\"><i>Modicogryllus</i> (<i>Modicogryllus</i>) <i>algirius algirius</i> (Saussure, 1877)</span> &#10003;</span>",
      "object_label": "Modicogryllus (Modicogryllus) algirius algirius (Saussure, 1877)",
      "global_id": "gid://taxon-works/Otu/24061",
      "base_class": "Otu",
      "url_for": "http://localhost:3000/api/v1/asserted_distributions",
      "object_url": "/otus/24061"
    },
    "geographic_area": {
      "id": 33609,
      "name": "Algeria",
      "level0_id": null,
      "level1_id": null,
      "level2_id": null,
      "parent_id": 33553,
      "geographic_area_type_id": 111,
      "iso_3166_a2": null,
      "iso_3166_a3": null,
      "tdwgID": "20ALG",
      "data_origin": "tdwg_l3",
      "created_by_id": 1,
      "updated_by_id": 1,
      "created_at": "2015-02-09T15:26:40.157Z",
      "updated_at": "2015-02-10T14:59:36.140Z",
      "shape": {
        "type": "Feature",
        "properties": {
          "geographic_area": {
            "id": 33609,
            "tag": "Algeria"
          }
        },
        "geometry": {
          "type": "MultiPolygon",
          "coordinates": " lengthy GeoJSON coordinate list would appear here ..."
        }
      },
      "geographic_area_type": {
        "id": 111,
        "name": "TDWG Level 3"
      },
      "parent": {
        "name": "Northern Africa"
      }
    }
  }
]
Type
array


/{id} get

GET: /asserted_distributions/{id}

Returns AssertedDistribution instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples4

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/asserted_distributions/{id}?project_id=4&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

/observations

See Overview at http://rdoc.taxonworks.org/Observation.html


/observations get

GET: /observations

Get all observations, optionally filtered


Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

descriptor_id

Identifier for the descriptor.

PropertyValue
requiredfalse
typeinteger
examples3

otu_id

Identifier for the otu for which the observation is made.

PropertyValue
requiredfalse
typeinteger
examples130037

page

The page of observations result set to retrieve.

PropertyValue
requiredfalse
typeinteger
examples5

per

The number of observations per page.

PropertyValue
requiredfalse
typeinteger
examples10

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

Response Headers

Pagination-Total

Total number of observations in result set.

PropertyValue
requiredtrue
typeinteger
examples30034

Pagination-Total-Pages

Total number of pages for result set.

PropertyValue
requiredtrue
typeinteger
examples300

Pagination-Page

Page number of result set.

PropertyValue
requiredtrue
typeinteger
examples5

Pagination-Per-Page

Number of observations per Page.

PropertyValue
requiredtrue
typeinteger
examples100

Pagination-Previous-Page

Previous page number.

PropertyValue
requiredtrue
typeinteger
examples4

Pagination-Next-Page

Next page number.

PropertyValue
requiredtrue
typeinteger
examples6

Possible Responses

200


/observations get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/observations?descriptor_id=3&otu_id=130037&page=5&per=10&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ

RESPONSE HEADERS

Pagination-Total: 30034
Pagination-Total-Pages: 300
Pagination-Page: 5
Pagination-Per-Page: 100
Pagination-Previous-Page: 4
Pagination-Next-Page: 6

RESPONSE BODY

200

{
  "id": 3,
  "descriptor_id": 3,
  "otu_id": 130037,
  "collection_object_id": null,
  "character_state_id": 7,
  "frequency": null,
  "continuous_value": null,
  "continuous_unit": null,
  "sample_n": null,
  "sample_min": null,
  "sample_max": null,
  "sample_median": null,
  "sample_mean": null,
  "sample_units": null,
  "sample_standard_error": null,
  "sample_standard_deviation": null,
  "presence": null,
  "description": null,
  "cached": null,
  "cached_column_label": null,
  "cached_row_label": null,
  "type": "Observation::Qualitative",
  "created_by_id": 2,
  "updated_by_id": 2,
  "project_id": 2,
  "created_at": "2020-10-12T18:58:02.305Z",
  "updated_at": "2020-10-12T18:58:02.305Z",
  "object_tag": "Foot smell: 3",
  "object_label": null,
  "global_id": "gid://taxon-works/Observation::Qualitative/3",
  "base_class": "Observation",
  "url_for": "http://localhost:3000/api/v1/observations/3",
  "object_url": "/observations/3"
}
Type
array


/{id} get

GET: /observations/{id}

Returns Observation instance data.


URI Parameters

id

PropertyValue
requiredtrue
typestring

Header Parameters

Authorization

API access token. Do not use with "token" query string parameter.

PropertyValue
requiredfalse
typestring
examplesToken eUUB4dQCCWlLGzksimEqNQ

Query Parameters

project_id

Project identifier. In the absence of a project token you must provide this parameter.

PropertyValue
requiredfalse
typeinteger
examples4

token

API access token. Do not use together with the "Authorization" header.

PropertyValue
requiredfalse
typestring
exampleseUUB4dQCCWlLGzksimEqNQ

project_token

A project (not User) token indicating the target project. Don't use together with a user token.

PropertyValue
requiredfalse
typestring
examplesrIO2oWS603c5W5laQ8ornn

/{id} get

CURL EXAMPLE

curl -X GET "https://{host}/api/{version}/observations/{id}?project_id=4&token=eUUB4dQCCWlLGzksimEqNQ&project_token=rIO2oWS603c5W5laQ8ornn" \
	-H "Authorization: Token eUUB4dQCCWlLGzksimEqNQ"

REQUEST HEADERS

Authorization: Token eUUB4dQCCWlLGzksimEqNQ