Commit 58cc7141 authored by Matija Obreza's avatar Matija Obreza
Browse files

Updated API docs for “coll” and “geo” fields

parent 8d8bd41e
......@@ -61,7 +61,7 @@ All other fields are optional.
"spauthor": "Colla",
"subtaxa": "var. sumatrana",
"subtauthor": "(Becc.) Nasution",
"orgCty": ...,
"orgCty": "NGA",
"acqDate": "20010301",
"mlsStat": true,
"inTrust": false,
......@@ -70,8 +70,8 @@ All other fields are optional.
"storage": [10, 20],
"sampStat": 200,
"duplSite": "BEL084",
"bredCode": ...,
"ancest": ....,
"bredCode": "NGA039",
"ancest": "PED/IG*REE",
"remarks": [ "remark1", "remark2" ],
"acceUrl": "https://my-genebank.org/accession/1",
"geo": {
......@@ -85,6 +85,80 @@ All other fields are optional.
<1> JSON object with geographic data
<2> JSON object with collecting data
=== Geographic data JSON model
The `geo` field in accession JSON captures geographic data:
[source,json,linenums]
----
{
"latitude": 13.12312,
"longitude": 42.2321,
"elevation": 123.2,
"coordUncert": 2000.0,
"coordDatum": "WGS84",
"georefMeth": "GPS"
}
----
[cols="1,3", options="header"]
.Relevant MCPD descriptors
|===
|Field name
|Description
|DECLATITUDE|Latitude expressed in decimal degrees. Positive values are North of the Equator; negative values are South of the Equator (e.g. `-44.6975`).
|DECLONGITUDE|Longitude expressed in decimal degrees. Positive values are East of the Greenwich Meridian; negative values are West of the Greenwich Meridian (e.g. `+120.9123`).
|ELEVATION|Elevation of collecting site expressed in meters above sea level. Negative values are not allowed.
|COORDUNCERT|Uncertainty associated with the coordinates in meters. Leave the value empty if the uncertainty is unknown.
|COORDDATUM|The geodetic datum or spatial reference system upon which the coordinates given in decimal latitude
and longitude are based (e.g. `WGS84`, `ETRS89`, `NAD83`). The GPS uses the WGS84 datum.
|GEOREFMETH|The georeferencing method used (`GPS`, determined from `map`, `gazetteer`, or `estimated using software`).
Leave the value empty if georeferencing method is not known.
|===
=== Collecting data JSON model
The `coll` field in accession JSON captures collecting data:
[source,json,linenums]
----
{
"collDate": "1990----",
"collSite": "7km south of Curitiba in the state of Parana",
"collNumb": "C90-23",
"collSrc": 12,
"collCode": "PER001",
"collName": null,
"collInstAddress": null,
"collMissId": "C90"
}
----
[cols="1,3", options="header"]
.Relevant MCPD descriptors
|===
|Field name
|Description
|COLLDATE|Collecting date of the sample, where YYYY is the year, MM is the month and DD is the day. Missing data (MM or DD) should be indicated with hyphens or '00' [double szero].
|COLLSITE|Location information below the country level that describes where the accession was collected,
preferable in English. This might include the distance in kilometers and direction from the nearest town,
village or map grid reference point, (e.g. `7km south of Curitiba in the state of Parana`).
|COLLNUMB|Original identifier assigned by the collector(s) of the sample, normally composed of the
name or initials of the collector(s) followed by a number (e.g. `FM9909`). This identifier is
essential for identifying duplicates held in different collections.
|COLLSRC|Collecting/acquisition source
|COLLCODE|FAO WIEWS code of the institute collecting the sample.
|COLLNAME|Name of the institute collecting the sample. This descriptor should only be used if
COLLCODE cannot be filled because the FAO WIEWS code for this institute is not available.
|COLLINSTADDRESS|Address of the institute collecting the sample. This descriptor should only
be used if COLLCODE cannot be filled because the FAO WIEWS code for this institute is not available.
|COLLMISSID|Identifier of the collecting mission used by the Collecting Institute (e.g. `CIATFOR-052`, `CN426`).
|===
=== Clearing existing values
To reset or clear an existing value in the accession passport data, it should be provided
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment