GET api/Location?requestType={requestType}
Gets information on locations based on 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. |
|
requestType |
one of: 'locations': returns a list of ObservationLocations 'list': returns a list of observations on a location |
string |
Default value is locations |
Body Parameters
None.
Response Information
Resource Description
Return FeatureWrapper
IHttpActionResultNone.
Response Formats
text/javascript
({"MetaData":{"InstitutionCodes":["sample string 1","sample string 2"],"CollectionCodes":["sample string 1","sample string 2"],"Datasets":[1,2],"Longitude":1.1,"Latitude":2.1,"Taxons":[1,2],"TaxonGroups":[1,2],"BasisOfRecords":["sample string 1","sample string 2"],"CoordinatePrecisionGroups":[1,2],"Tags":["sample string 1","sample string 2"],"Count":3,"MediaCount":4,"MaxDate":"2023-02-09T02:50:25.2746024+01:00","MinDate":"2023-02-09T02:50:25.2746024+01:00","Behaviors":["sample string 1","sample string 2"],"Areas":["sample string 1","sample string 2"],"TaxonIds":[1,2],"CoordinatePrecision":7,"Coordinates":"sample string 8","TaxonStats":[{"Id":1,"Name":"sample string 2","ScientificName":"sample string 3","Count":4,"TaxonGroupId":5},{"Id":1,"Name":"sample string 2","ScientificName":"sample string 3","Count":4,"TaxonGroupId":5}],"TaxonGroupStats":[{"Id":1,"Name":"sample string 2","Count":3},{"Id":1,"Name":"sample string 2","Count":3}],"LocationId":"sample string 9","ListCount":10,"Locality":"sample string 11","HasMedia":true,"SourceDataIds":[1,2],"Geometry":"sample string 13"},"ObservationList":[{"Id":"sample string 1","ArtsId":"sample string 2","BasisOfRecord":"sample string 3","SpeciesGroup":"sample string 4","InstitutionCode":"sample string 5","CollectionCode":"sample string 6","CollectionNumber":"sample string 7","InstitutionLogoUrl":"sample string 8","Name":"sample string 9","ScientificName":"sample string 10","ObservationDate":"sample string 11","Collector":"sample string 12","Status":"sample string 13","Institution":"sample string 14","Precision":"sample string 15","Locality":"sample string 16","HasPhoto":true,"Behavior":"sample string 18"},{"Id":"sample string 1","ArtsId":"sample string 2","BasisOfRecord":"sample string 3","SpeciesGroup":"sample string 4","InstitutionCode":"sample string 5","CollectionCode":"sample string 6","CollectionNumber":"sample string 7","InstitutionLogoUrl":"sample string 8","Name":"sample string 9","ScientificName":"sample string 10","ObservationDate":"sample string 11","Collector":"sample string 12","Status":"sample string 13","Institution":"sample string 14","Precision":"sample string 15","Locality":"sample string 16","HasPhoto":true,"Behavior":"sample string 18"}],"HasFilter":true});
application/json, text/json
{ "MetaData": { "InstitutionCodes": [ "sample string 1", "sample string 2" ], "CollectionCodes": [ "sample string 1", "sample string 2" ], "Datasets": [ 1, 2 ], "Longitude": 1.1, "Latitude": 2.1, "Taxons": [ 1, 2 ], "TaxonGroups": [ 1, 2 ], "BasisOfRecords": [ "sample string 1", "sample string 2" ], "CoordinatePrecisionGroups": [ 1, 2 ], "Tags": [ "sample string 1", "sample string 2" ], "Count": 3, "MediaCount": 4, "MaxDate": "2023-02-09T02:50:25.2746024+01:00", "MinDate": "2023-02-09T02:50:25.2746024+01:00", "Behaviors": [ "sample string 1", "sample string 2" ], "Areas": [ "sample string 1", "sample string 2" ], "TaxonIds": [ 1, 2 ], "CoordinatePrecision": 7, "Coordinates": "sample string 8", "TaxonStats": [ { "Id": 1, "Name": "sample string 2", "ScientificName": "sample string 3", "Count": 4, "TaxonGroupId": 5 }, { "Id": 1, "Name": "sample string 2", "ScientificName": "sample string 3", "Count": 4, "TaxonGroupId": 5 } ], "TaxonGroupStats": [ { "Id": 1, "Name": "sample string 2", "Count": 3 }, { "Id": 1, "Name": "sample string 2", "Count": 3 } ], "LocationId": "sample string 9", "ListCount": 10, "Locality": "sample string 11", "HasMedia": true, "SourceDataIds": [ 1, 2 ], "Geometry": "sample string 13" }, "ObservationList": [ { "Id": "sample string 1", "ArtsId": "sample string 2", "BasisOfRecord": "sample string 3", "SpeciesGroup": "sample string 4", "InstitutionCode": "sample string 5", "CollectionCode": "sample string 6", "CollectionNumber": "sample string 7", "InstitutionLogoUrl": "sample string 8", "Name": "sample string 9", "ScientificName": "sample string 10", "ObservationDate": "sample string 11", "Collector": "sample string 12", "Status": "sample string 13", "Institution": "sample string 14", "Precision": "sample string 15", "Locality": "sample string 16", "HasPhoto": true, "Behavior": "sample string 18" }, { "Id": "sample string 1", "ArtsId": "sample string 2", "BasisOfRecord": "sample string 3", "SpeciesGroup": "sample string 4", "InstitutionCode": "sample string 5", "CollectionCode": "sample string 6", "CollectionNumber": "sample string 7", "InstitutionLogoUrl": "sample string 8", "Name": "sample string 9", "ScientificName": "sample string 10", "ObservationDate": "sample string 11", "Collector": "sample string 12", "Status": "sample string 13", "Institution": "sample string 14", "Precision": "sample string 15", "Locality": "sample string 16", "HasPhoto": true, "Behavior": "sample string 18" } ], "HasFilter": true }
application/xml, text/xml
<ObservationLocationWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Artskart.UI.Classes"> <HasFilter>true</HasFilter> <MetaData xmlns:d2p1="http://schemas.datacontract.org/2004/07/Artskart.Model.Objects"> <d2p1:Areas xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:Areas> <d2p1:BasisOfRecords xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:BasisOfRecords> <d2p1:Behaviors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:Behaviors> <d2p1:CollectionCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:CollectionCodes> <d2p1:CoordinatePrecision>7</d2p1:CoordinatePrecision> <d2p1:CoordinatePrecisionGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:CoordinatePrecisionGroups> <d2p1:Coordinates>sample string 8</d2p1:Coordinates> <d2p1:Count>3</d2p1:Count> <d2p1:Datasets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:Datasets> <d2p1:Geometry>sample string 13</d2p1:Geometry> <d2p1:HasMedia>true</d2p1:HasMedia> <d2p1:InstitutionCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:InstitutionCodes> <d2p1:Latitude>2.1</d2p1:Latitude> <d2p1:ListCount>10</d2p1:ListCount> <d2p1:Locality>sample string 11</d2p1:Locality> <d2p1:LocationId>sample string 9</d2p1:LocationId> <d2p1:Longitude>1.1</d2p1:Longitude> <d2p1:MaxDate>2023-02-09T02:50:25.2746024+01:00</d2p1:MaxDate> <d2p1:MediaCount>4</d2p1:MediaCount> <d2p1:MinDate>2023-02-09T02:50:25.2746024+01:00</d2p1:MinDate> <d2p1:SourceDataIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:SourceDataIds> <d2p1:Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </d2p1:Tags> <d2p1:TaxonGroupStats> <d2p1:TaxonGroupStats> <d2p1:Count>3</d2p1:Count> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:TaxonGroupStats> <d2p1:TaxonGroupStats> <d2p1:Count>3</d2p1:Count> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> </d2p1:TaxonGroupStats> </d2p1:TaxonGroupStats> <d2p1:TaxonGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:TaxonGroups> <d2p1:TaxonIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:TaxonIds> <d2p1:TaxonStats> <d2p1:TaxonStats> <d2p1:Count>4</d2p1:Count> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:ScientificName>sample string 3</d2p1:ScientificName> <d2p1:TaxonGroupId>5</d2p1:TaxonGroupId> </d2p1:TaxonStats> <d2p1:TaxonStats> <d2p1:Count>4</d2p1:Count> <d2p1:Id>1</d2p1:Id> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:ScientificName>sample string 3</d2p1:ScientificName> <d2p1:TaxonGroupId>5</d2p1:TaxonGroupId> </d2p1:TaxonStats> </d2p1:TaxonStats> <d2p1:Taxons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </d2p1:Taxons> </MetaData> <ObservationList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Artskart.Model.RavenDb.Transformers"> <d2p1:ObservationListItem> <d2p1:ArtsId>sample string 2</d2p1:ArtsId> <d2p1:BasisOfRecord>sample string 3</d2p1:BasisOfRecord> <d2p1:Behavior>sample string 18</d2p1:Behavior> <d2p1:CollectionCode>sample string 6</d2p1:CollectionCode> <d2p1:CollectionNumber>sample string 7</d2p1:CollectionNumber> <d2p1:Collector>sample string 12</d2p1:Collector> <d2p1:HasPhoto>true</d2p1:HasPhoto> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:Institution>sample string 14</d2p1:Institution> <d2p1:InstitutionCode>sample string 5</d2p1:InstitutionCode> <d2p1:InstitutionLogoUrl>sample string 8</d2p1:InstitutionLogoUrl> <d2p1:Locality>sample string 16</d2p1:Locality> <d2p1:Name>sample string 9</d2p1:Name> <d2p1:ObservationDate>sample string 11</d2p1:ObservationDate> <d2p1:Precision>sample string 15</d2p1:Precision> <d2p1:ScientificName>sample string 10</d2p1:ScientificName> <d2p1:SpeciesGroup>sample string 4</d2p1:SpeciesGroup> <d2p1:Status>sample string 13</d2p1:Status> </d2p1:ObservationListItem> <d2p1:ObservationListItem> <d2p1:ArtsId>sample string 2</d2p1:ArtsId> <d2p1:BasisOfRecord>sample string 3</d2p1:BasisOfRecord> <d2p1:Behavior>sample string 18</d2p1:Behavior> <d2p1:CollectionCode>sample string 6</d2p1:CollectionCode> <d2p1:CollectionNumber>sample string 7</d2p1:CollectionNumber> <d2p1:Collector>sample string 12</d2p1:Collector> <d2p1:HasPhoto>true</d2p1:HasPhoto> <d2p1:Id>sample string 1</d2p1:Id> <d2p1:Institution>sample string 14</d2p1:Institution> <d2p1:InstitutionCode>sample string 5</d2p1:InstitutionCode> <d2p1:InstitutionLogoUrl>sample string 8</d2p1:InstitutionLogoUrl> <d2p1:Locality>sample string 16</d2p1:Locality> <d2p1:Name>sample string 9</d2p1:Name> <d2p1:ObservationDate>sample string 11</d2p1:ObservationDate> <d2p1:Precision>sample string 15</d2p1:Precision> <d2p1:ScientificName>sample string 10</d2p1:ScientificName> <d2p1:SpeciesGroup>sample string 4</d2p1:SpeciesGroup> <d2p1:Status>sample string 13</d2p1:Status> </d2p1:ObservationListItem> </ObservationList> </ObservationLocationWrapper>
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.