GET api/observations/specieslist?pageIndex={pageIndex}&pageSize={pageSize}
Gets a list of species/taxons for the observations that matches a filter
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Areas |
Gets or sets the areas. |
Collection of string |
None. |
BasisOfRecords |
Gets or sets the basis of records. |
Collection of string |
None. |
Behaviors |
Gets or sets the behaviors. |
Collection of string |
None. |
Bounds |
Gets or sets the bounds. |
Bounds |
None. |
Collections |
Gets or sets the collections. |
Collection of string |
None. |
Countys |
Gets or sets the countys. |
Collection of string |
None. |
Datasets |
Gets or sets the datasets. |
Collection of integer |
None. |
Datetimecollected |
Gets or sets the datetimecollected. |
Collection of string |
None. |
FromDate |
Gets or sets the from date. |
date |
None. |
Id |
Gets or sets the id. |
string |
None. |
IncludeChildTaxons |
Gets or sets a value indicating whether include child taxons. |
boolean |
None. |
IncludeObsNoPrec |
Gets or sets the include obs no prec. |
boolean |
None. |
Institutions |
Gets or sets the institutions. |
Collection of string |
None. |
Latitude |
Gets or sets the latitude. |
decimal number |
None. |
Longitude |
Gets or sets the longitude. |
decimal number |
None. |
MaxMarkers |
Gets or sets the max markers. |
integer |
None. |
OnlyImageObs |
Gets or sets the only image obs. |
boolean |
None. |
Precision |
Gets or sets the precision. |
Collection of string |
None. |
SourceDatabases |
Gets or sets the source databases. |
Collection of string |
None. |
Status |
Gets or sets the status. |
Collection of string |
None. |
Taxongroups |
Gets or sets the taxongroups. |
Collection of integer |
None. |
Taxons |
Gets or sets the taxons. |
Collection of integer |
None. |
ToDate |
Gets or sets the to date. |
date |
None. |
WktPolygon |
WktPolygon to filter with - Utm Sone 33 coordinate system. By passing the parameter as GmWktPolygon - Google Mercator coordinates may be used... |
string |
None. |
ZoomLevel |
The openlayers Zoomlevel - only relevant in the Location Api - for aggregation of data |
integer |
None. |
AlwaysIncludePolygonData | boolean |
None. |
|
pageIndex |
The page index. optional: default = 0 |
integer |
Default value is 0 |
pageSize |
The page size - optional: default = 25 |
integer |
Default value is 25 |
Body Parameters
None.
Response Information
Resource Description
Returns SpeciesListResult
SpeciesListResultName | Description | Type | Additional information |
---|---|---|---|
SpeciesList |
Gets or sets the species list. |
Collection of SpeciesListItem |
None. |
PageIndex |
The page index. |
integer |
None. |
PageSize |
The page size |
integer |
None. |
TotalCount |
The total result count |
integer |
None. |
TotalPages |
The total number of pages based on totalresult and page size |
integer |
None. |
Response Formats
text/javascript
({"SpeciesList":[{"TaxonId":31244,"ScientificName":"Capreolus capreolus","PopularName":"rådyr","Count":4869},{"TaxonId":31241,"ScientificName":"Alces alces","PopularName":"elg","Count":3127}],"PageIndex":0,"PageSize":20,"TotalCount":2,"TotalPages":1});
application/json, text/json
{ "SpeciesList": [ { "TaxonId": 31244, "ScientificName": "Capreolus capreolus", "PopularName": "rådyr", "Count": 4869 }, { "TaxonId": 31241, "ScientificName": "Alces alces", "PopularName": "elg", "Count": 3127 } ], "PageIndex": 0, "PageSize": 20, "TotalCount": 2, "TotalPages": 1 }
application/xml, text/xml
<SpeciesListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Artskart.Model.Public"> <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Artskart.Model.Public.Helpers">0</PageIndex> <PageSize xmlns="http://schemas.datacontract.org/2004/07/Artskart.Model.Public.Helpers">20</PageSize> <TotalCount xmlns="http://schemas.datacontract.org/2004/07/Artskart.Model.Public.Helpers">2</TotalCount> <SpeciesList> <SpeciesListItem> <Count>4869</Count> <PopularName>rådyr</PopularName> <ScientificName>Capreolus capreolus</ScientificName> <TaxonId>31244</TaxonId> </SpeciesListItem> <SpeciesListItem> <Count>3127</Count> <PopularName>elg</PopularName> <ScientificName>Alces alces</ScientificName> <TaxonId>31241</TaxonId> </SpeciesListItem> </SpeciesList> </SpeciesListResult>
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel
Will return an Excel worksheet fileresult. Generate by using accept header or add '?format=excel' to request url.