| Tip | ||
|---|---|---|
| ||
/names |
Returns a paged list of names details.
Parameters
All parameters are optional.
| page | The pagination offset for the list of results starting at 1. | |
|---|---|---|
| pagesize | The number of results to display during pagination (default = 10). | |
| frommodifieddate | The earliest modified date for any of the results | parentNameId. The format of the date is yyyy-dd-mm. |
| parentnameid | The unique identifier of the direct parent name. | |
| ancestornameid | The unique identifier of any ancestor name. | |
| biostatus | ||
| status |
| Info |
|---|
Use either the parentNameId or ancestorNameId parameter to retrieve the children or all descendants of a name. |
Response
The response will include the full details of the requested names.
| Names | An array of the name details |
|---|---|
| Total | The total number of names that match the request parameters. |
| Page | The pagination offset for the list of results. |
| PageSize | The maximum number of records that will be returned for the request. |
Example response (abbreviated)
| Code Block | ||
|---|---|---|
| ||
{
"Names": [
{
"NameId": "030e9726-81c5-4aaa-b6d6-dada939f91ab",
"Class": "Scientific Name",
"FullName": "Peziza herbarum Pers., 1794",
...
},
...
],
"Total": 85,
"Page": 1,
"PageSize": 10
} |
Examples
Returning a list of records to maintain a local cache.
| Panel |
|---|
http://data.nzor.org.nz/names?frommodifieddate=2013-1-16 |
This will return a list of names that have been modified since January 16 2013.