GET api/taxon/summary?start={start}&limit={limit}&sort={sort}&dir={dir}&taxonName={taxonName}&taxonGroupName={taxonGroupName}&taxonDesignationId={taxonDesignationId}&taxonDesignationGroupId={taxonDesignationGroupId}&keyword={keyword}&hasProfile={hasProfile}
Gets the taxon summary. This service is open but a valid nbdcToken cookie needs to be provided in a request header to see draft profiles.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| start |
The start. |
integer |
Default value is 1 |
| limit |
The limit. |
integer |
Default value is 25 |
| sort |
The sorting field. |
string |
None. |
| dir |
The direction. |
string |
Default value is asc |
| taxonName |
Name of the taxon. |
string |
None. |
| taxonGroupName |
Name of the taxon group. |
string |
None. |
| taxonDesignationId |
The taxon designation identifier. |
integer |
None. |
| taxonDesignationGroupId |
The taxon designation group identifier. |
integer |
None. |
| keyword |
The keyword. |
string |
None. |
| hasProfile |
The has profile. |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
TaxonWithProfileSummaryResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| results |
Gets the total number of records. |
integer |
None. |
| data |
Gets the taxon records. |
Collection of TaxonWithProfileSummary |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.