| Tip | ||
|---|---|---|
| ||
/names |
Returns a paged list of summary name linksnames 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 |
Example Response
/names
...
| 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 | ||||
|---|---|---|---|---|
| <?xml version="1.0" encoding="utf-8"?>
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Total>122022</Total>
<Page>1</Page>
<PageSize>10</PageSize>
<Names>
| |||
{ "Names": [ { <NameLink> <NameId>397b0771-3577-472e-a6e8-00009a4d0b4e</NameId>"NameId": "030e9726-81c5-4aaa-b6d6-dada939f91ab", <FullName>Yellowing Curtain Crust</FullName> "Class": <PartialName/> "Scientific Name", <Rank>none</Rank> <ModifiedDate>2011-11-25T15:20:41.607</ModifiedDate> </NameLink>"FullName": "Peziza herbarum Pers., 1794", <NameLink> <NameId>24cfddf1-8135-4ac0-b906-00034ee7fe61</NameId> <FullName>Uncinia uncinata var. pedicellata (Kük.) Petrie 1915</FullName> <PartialName>Uncinia uncinata var. pedicellata</PartialName> <Rank>variety</Rank> }, <ModifiedDate>2011-11-22T11:50:20.14</ModifiedDate> </NameLink> ... ], <NameLink> "Total": 85, <NameId>0ea4f4ac-5199-4f65-ac94-0007ac0691e7</NameId> "Page": 1, <FullName>Ypsilothuria</FullName> <PartialName>Ypsilothuria</PartialName> <Rank>genus</Rank> <ModifiedDate>2011-11-22T11:50:20.14</ModifiedDate> </NameLink> </Names> </Response> "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.