OJ Break API Data Type Glossary

Introduction

This page is the data type glossary for the OJ Break API Reference. Here you can find the definitions and types of data present in the API.

Special Data Types

Boolean_Flag

A data type that represents a boolean state with the affirmative marked with a Y and the negative marked with a N.

Classes

assocation (extension of taxon_basic)

type

String - describes the type of the specimen.

relationship

String - describes an evolutionary relationship of the specimen.

hier

Array of taxon_hierarchy - array of taxon_hierarchy elements.

cuids

Array of cuid - array of cuid elements for the specimens being associated.

valid_taxon

Array of taxon_basic - array of taxon_basic elements (only present when specified)

association_info

cuid

cuid - cuid element.

type

String

type_full

String

author_basic

author_id

author_id - author_id element

last_name

String - The family name of an author.

initials

String - The initials for the given name of an author.

generation

String - The generational designation (Jr., III, etc.) for an author.

name_order

String - An indicator specifying whether an author's name should be formatted according to western (W) or eastern (E) conventions.

author_extended (extension of author_basic)

preferred

Boolean_flag - Boolean_flag indicator which signifies if the current identification information is the author's preferred information.

author_info (extension of author_extended)

address

String - Full address of an author.

address1

String - First part of an author's full address.

address2

String - Second part of an author's full address.

address3

String - Third part of an author's full address.

address4

String - Fourth part of an author's full address.

city

String - Name of city where an author is from.

state

String - Name of state where an author is from.

zip_code

String - Postal code for an author's mailing location.

country

String - Name of country where an author is from.

email

String - Contact email address for an author.

mailing_list

Boolean_flag

phone

String - Contact telephone number for an author.

fax

String - Contact fax number for an author.

web

String - Personal website for an author.

title

String - Official prefix of an author's name.

image

URL - Url location of thumbnail of an author.

bio

String - Short description of an author's professional background and/or current works.

year_born

String - Year of birth for an author.

year_died

String - Year of death for an author.

base_tcid

String

base_taxon

String

num_spms

Number - Number of specimens collected by an author.

num_coll_events

Number - Number of collecting trips for an author.

num_pubs

Number - Number of publications by an author.

synonyms

Array of author_extended - Array of author_extended class elements

privs

Array of number

admin_insts

Array

collection

inst_id

inst_id - inst_id element.

inst_coden

String - the unique identifier of a particular institution, usually present for specimen cataloging.

cuid

cuid - cuid element (only present when defined)

collection_extended (extension of collection)

inst_name

String - name of the collection (institution)

spm_count

Number - count of specimens in the current institution.

collector

date

String - The date of the collecting event.

coll_method

String - The method by which the collector collected a specimen.

collector

String - The name of the collector.

collector_extended

Array of collector_basic - array of collector_basic elements for the selected collector.

ceid

ceid - ceid element for a certain collecting trip.

collector_basic

collector_id

collector_id - collector_id element.

last_name

String - family name for the collector.

intitials

String - The initials for the given name of an author.

generation

String - The generational designation (Jr., III, etc.) for an author.

name_order

String - An indicator specifying whether an author's name should be formatted according to western (W) or eastern (E) conventions.

collector_extended (extension of collector)

coll_time

String - The time of the collecting event.

date_type

String - The type of date used to record the collecting event.

field_code

String

collector_icon

collector_id

collector_id - collector_id element (only present if specified)

name

String - The name of the collector (only present if specified).

url

URL - A URL to an icon for the collector.

contribution

contrib_id

person_id - person_id element for the contributor

last_name

String - The family name of a contributor.

initials

String - The initials for the given name of a contributor.

name

String - The full name of a contributor.

contrib_types

contrib_types - contrib_types class

contrib_literature_basic (extension of literature_basic)

contrib_pub_id

pub_id - pub_id element for the contribution to the underlying publication (only present for contributions)

contrib_author_base_id

author_id - author_id element for the contributing author(s) (only present for contributions)

contrib_author

String - The comma separated list of contributing authors' family names (only present for contributions).

contrib_author_extended

Array of author_basic - array of author_basic elements for the contribution (only present for contributions)

contrib_title

String - The title for the contribution (only present for contributions).

contrib_types

taxon

Boolean_Flag - A flag specifying whether a contributor contributed taxonomic information

literature

Boolean_Flag - A flag specifying whether a contributor contributed literature information

occurrence

Boolean_Flag - A flag specifying whether a contributor contributed occurrence information

media

Boolean_Flag - A flag specifying whether a contributor contributed media resources

determination_basic

determiner_id

determiner_id - determiner_id element.

status

String - status of the determination

determiner

String - name of determiner

determination_extended (extension of determination_basic)

det_id

det_id - det_id element

det_date

String - date of the determination

det_status

String - status of the determination

type_status

String

cu_coll_id

Number

coll_id

coll_id - coll_id element

homonym

Boolean_flag - Boolean_flag indicating whether or not the determination was a homonym

habitat

String - description of the habitat that a taxon is known to inhabit.

images

Array - loc_name (String), thumbnail (URL), and fullsize (URL).

literature_basic

pub_id

pub_id - pub_id element for the publication

type

String - The type of format in which this piece of literature was published.

author_base_id

author_id - author_id element for the author(s)

author

String - The comma separated list of authors' family names.

author_extended

Array of author_basic - array of author_basic elements for the publication

title

String - The title of the publication.

year

String - The year of publication.

month

String - The month of publication.

doi

String - The digital object identifier (DOI) assigned to a publication.

journal

String - The journal in which the article was published (only present for articles and bulletins)

journal_id

jrnl_id - jrnl_id element (only present for articles and bulletins)

series

String - The series of a journal in which an article was published (only present for articles and bulletins)

volume

String - The volume of a journal in which an article was published (only present for articles and bulletins)

vol_num

String - The part (number) within a volume of a journal in which an article was published (only present for articles and bulletins)

publisher

String - The organization that published the book (only present for books and chapters)

city

String - The city in which the book was published (only present for books and chapters)

start_page

String - The starting page of a publication (only present for articles and chapters)

end_page

String - The ending page of a publication (only present for articles and chapters)

num_pages

String - The total number of pages of a publication (only present for books, chapters, and bulletins)

chap_title

String - The title of the chapter (only present for chapters).

chap_num

String - The designation for a chapter within a book (only present for chapters).

chap_author

String - The comma separated list of chapter authors' family names (only present for chapters).

chap_author_extended

Array of author_basic - array of author_basic elements for the chapter (only present for chapters)

book_id

pub_id - pub_id element of the book for a chapter (only present for chapters)

literature_extended (extension of literature_basic)

url

URL - a url to the specified literature pdf

filesize

String - The size of the linked pdf file

pages

Array of page - array of page elements for the literature

public

Boolean_flag - a flag specifying if the literature is available to the public

loc_basic

lat

lat - lat element.

lng

lng - lng element.

type

String - A measure of confidence in the accuracy of the coordinates for the locality in either point (confident) or polygon (unconfident).

loc_name

String - the name of the locality.

loc_id

loc_id - loc_id element.

loc_coords (extension of loc_basic)

source

String - The data source used to obtain the coordinates for the locality.

icon

collector_icon - collector_icon class

loc_coords_extended (extension of loc_coords)

elev

String - measurement of the elevation of the location (in meters)

max_elev

String - maximum measurement of the elevation of the location (in meters)

loc_comments

String - miscellaneous descriptions or statements about the locality

loc_info (extension of loc_basic)

type

String - specifies type as either vouchered or unvouchered.

coords

String - gives coordinates of locality in coordinate notation.

media_basic (extension of taxon_basic)

media_id

media_id - media_id element

media_type

media_type - media_type element

copyright

String - copyright information

license

String - licensing information

normalRes

URL - a url to the normal resolution media

highRes

URL - a url to the high resolution media

highResSource

URL - a url to the high resolution version of an image

highResSourceType

String - description of the type of the high resolution image

caption

String - a description/summary of the image itself

thumb

URL - a url to the thumbnail version of an image

page

String - page number corresponding to the linked publication.

url

URL - a url to the pdf version of the page to the specified publication.

place

type

String - a classification of the region where the place is located.

pnid

pnid - pnid element.

name

String - name of the place.

level

level - level element.

preparation

prep_type

String - type of container for the preparation

prep_contents

String - medium or content of the preparation

num_preps

String - number of containers not individuals associated with the preparation

pub_basic

year

String - year the publication was published

month

String - month the publication was published

comments

String - miscellaneous comments about the publication

pages

Array of page - array of page elements for the publication.

pub_extended (extension of pub_basic)

public

Boolean_flag - a Boolean_flag indicating whether the publication is public or not

author

String - name of the author of the publication

pub_id

pub_id - pub_id element

full_pdf

URL - a url to the pdf version of the publication

record (extension of loc_coords_extended, collector and collection_extended)

vouchered

boolean - boolean value representing whether the occurrence record is vouchered or not

spm_num

Number - number of specimens associated with the record

coll_date

String - date of the collection record

coll_date_alt

String - alternate representation of the collecting date

date_type

String - type of the date given

coll_method

String - name of the collecting method used to capture the specimen record

collector

String - name of the collector

collector_alt

String - an alternate representation of the collector's name

habitat

String - description of the habitat that the specimen inhabits

field_code

String - code used to identify the collecting event in the field

comments

String - text related to the occurrence record that may include label data, specimen condition, etc.

Order

String - name of the order in which the records belongs

enterer

String - name of the person who entered the data for the specified record.

last_update

String - date of the last update for the specified record

sequences

Array of sequence - array of sequence class for the current record.

record_part

spm_num

Number - number of specimens associated with the record

spm_sex

spm_sex - spm_sex element

life_status

life_status - life_status element

preparations

Array of preparation - array of preparation elements

record_unvouchered (extension of record)

unv_id

String - unv_id element

determinations

Array of determination - array of determination elements

record_vouchered (extension of record)

cuid

String - cuid element

alt_ids

Array of cuid - array of cuid

spm_sex

spm_sex - spm_sex element

life_status

life_status - life_status element

coll_time

Array - start (String) and end (String) time values when defined. null when absent

collector_extended

Array of collector_basic - array of collector_basic elements for the collector.

ceid

ceid - ceid element.

preparations

Array of preparation - array of preparation elements

spm_groups

Array of record_part - array of record_part elements. Only present when values are available

determinations

Array of determination_extended - array of determination_extended elements

associations

Array of association_info - array of association_info elements

images

Array of media_info - array of media_info elements

date_recorded

String - the date the original record was transcribed

updater

String - name of the person who updated the data for the specified record.

sequence

String - DNA sequence of the specimen.

seq_result

Boolean_flag

pcr_result

Boolean_flag

extract_notes

String

extract_quality

Boolean_flag

pcr_notes

String

lab_code

String

gene

String

primers

Array of string - array of two components 'forward' and 'reverse' strings.

taxon_basic

tnuid

tnuid - tnuid element

taxon

taxon - taxon element

author

author - author element

taxon_extended (extension of taxon_basic)

status

status - status element

rank

rank - rank element

valid

valid - valid element

fossil

fossil - fossil element

num_spms

num_spms - num_spms element (only present when option is specified)

taxon_rel_extended (extension of taxon_extended)

rel_type

rel_type - rel_type element