GET api/Facets

Gets a list of facets for observations matching the filter

Request Information

URI Parameters

NameDescriptionTypeAdditional 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.

Body Parameters

None.

Response Information

Resource Description

List of Facets

Collection of ArtskartFacet
NameDescriptionTypeAdditional information
Id

Gets or sets the id.

string

None.

IsCollapsible

Gets or sets a value indicating whether is collapsible.

boolean

None.

Name

Gets or sets the name.

string

None.

Values

Gets or sets the values.

Collection of ArtskartFacetValue

None.

Response Formats

text/javascript

Sample:
([{"Id":"sample string 1","IsCollapsible":true,"Name":"sample string 3","Values":[{"Average":1.1,"Count":1.1,"Hits":1,"InitiallyVisible":true,"Max":1.1,"Min":1.1,"Name":"sample string 3","Range":"sample string 4","Selected":true,"Sum":1.1},{"Average":1.1,"Count":1.1,"Hits":1,"InitiallyVisible":true,"Max":1.1,"Min":1.1,"Name":"sample string 3","Range":"sample string 4","Selected":true,"Sum":1.1}]},{"Id":"sample string 1","IsCollapsible":true,"Name":"sample string 3","Values":[{"Average":1.1,"Count":1.1,"Hits":1,"InitiallyVisible":true,"Max":1.1,"Min":1.1,"Name":"sample string 3","Range":"sample string 4","Selected":true,"Sum":1.1},{"Average":1.1,"Count":1.1,"Hits":1,"InitiallyVisible":true,"Max":1.1,"Min":1.1,"Name":"sample string 3","Range":"sample string 4","Selected":true,"Sum":1.1}]}]);

application/json, text/json

Sample:
[
  {
    "Id": "sample string 1",
    "IsCollapsible": true,
    "Name": "sample string 3",
    "Values": [
      {
        "Average": 1.1,
        "Count": 1.1,
        "Hits": 1,
        "InitiallyVisible": true,
        "Max": 1.1,
        "Min": 1.1,
        "Name": "sample string 3",
        "Range": "sample string 4",
        "Selected": true,
        "Sum": 1.1
      },
      {
        "Average": 1.1,
        "Count": 1.1,
        "Hits": 1,
        "InitiallyVisible": true,
        "Max": 1.1,
        "Min": 1.1,
        "Name": "sample string 3",
        "Range": "sample string 4",
        "Selected": true,
        "Sum": 1.1
      }
    ]
  },
  {
    "Id": "sample string 1",
    "IsCollapsible": true,
    "Name": "sample string 3",
    "Values": [
      {
        "Average": 1.1,
        "Count": 1.1,
        "Hits": 1,
        "InitiallyVisible": true,
        "Max": 1.1,
        "Min": 1.1,
        "Name": "sample string 3",
        "Range": "sample string 4",
        "Selected": true,
        "Sum": 1.1
      },
      {
        "Average": 1.1,
        "Count": 1.1,
        "Hits": 1,
        "InitiallyVisible": true,
        "Max": 1.1,
        "Min": 1.1,
        "Name": "sample string 3",
        "Range": "sample string 4",
        "Selected": true,
        "Sum": 1.1
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfArtskartFacet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Artskart.Model.Public">
  <ArtskartFacet>
    <Id>sample string 1</Id>
    <IsCollapsible>true</IsCollapsible>
    <Name>sample string 3</Name>
    <Values>
      <ArtskartFacetValue>
        <Average>1.1</Average>
        <Count>1.1</Count>
        <Hits>1</Hits>
        <InitiallyVisible>true</InitiallyVisible>
        <Max>1.1</Max>
        <Min>1.1</Min>
        <Name>sample string 3</Name>
        <Range>sample string 4</Range>
        <Selected>true</Selected>
        <Sum>1.1</Sum>
      </ArtskartFacetValue>
      <ArtskartFacetValue>
        <Average>1.1</Average>
        <Count>1.1</Count>
        <Hits>1</Hits>
        <InitiallyVisible>true</InitiallyVisible>
        <Max>1.1</Max>
        <Min>1.1</Min>
        <Name>sample string 3</Name>
        <Range>sample string 4</Range>
        <Selected>true</Selected>
        <Sum>1.1</Sum>
      </ArtskartFacetValue>
    </Values>
  </ArtskartFacet>
  <ArtskartFacet>
    <Id>sample string 1</Id>
    <IsCollapsible>true</IsCollapsible>
    <Name>sample string 3</Name>
    <Values>
      <ArtskartFacetValue>
        <Average>1.1</Average>
        <Count>1.1</Count>
        <Hits>1</Hits>
        <InitiallyVisible>true</InitiallyVisible>
        <Max>1.1</Max>
        <Min>1.1</Min>
        <Name>sample string 3</Name>
        <Range>sample string 4</Range>
        <Selected>true</Selected>
        <Sum>1.1</Sum>
      </ArtskartFacetValue>
      <ArtskartFacetValue>
        <Average>1.1</Average>
        <Count>1.1</Count>
        <Hits>1</Hits>
        <InitiallyVisible>true</InitiallyVisible>
        <Max>1.1</Max>
        <Min>1.1</Min>
        <Name>sample string 3</Name>
        <Range>sample string 4</Range>
        <Selected>true</Selected>
        <Sum>1.1</Sum>
      </ArtskartFacetValue>
    </Values>
  </ArtskartFacet>
</ArrayOfArtskartFacet>

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel

Sample:
Will return an Excel worksheet fileresult. Generate by using accept header or add '?format=excel' to request url.