Occurrence Web Services (old reference)

Occurrences

• Occurrence search - Performs a GET search: /occurrences/search?q=*:*
  • q - the initial query. "q=*:*" will query anything, q="macropus" will do a free text search for "macropus", q=kingdom:Fungi will search for records with a kingdom of Fungi.
    For a listing of the fields that can be queried in a q=INDEXEDFIELD:VALUE fashion, see /index/fields
  • fq - filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi.
    Again, see /index/fields for all the fields that a queryable.
  • Extra Spatial Search Parameters - These will be applied to the initial base query in q. When no q is provided *:* will be used.
    • lat - the decimal latitude to limit records to. Use with lon and radius to specify a "search" circle.
    • lon - the decimal longitude to limit records to. Use with lat and radius to specify a "search" circle.
    • radius - the radius in which to limit records (relative to the lat, lon point). Use with lat and lon to specify a "search" circle.
    • wkt - the polygon area in which to limit records. For information on Well known text, see this
  • fl - a comma separated list of fields to use in search result. It will use a default set of values when not supplied. Only the "stored" fields can be included in results. See /index/fields for all the fields.
  • facet - supported values are "off" or "on". By default, its "on". This is worth switching off if facetting is not required, to reduce the JSON being sent
  • facets - the fields to create facets on e.g. facets=basis_of_record.
  • pageSize - number of records to return
  • startIndex - record offset, to enable paging
  • sort - the indexed field to sort by. See /index/fields
  • dir - supports "asc" or "desc"
  • flimit - maximum number of facets to return
  • fsort - method in which to sort the facets either "count" or "index". This value is only applicable for facets that are NOT included in /search/grouped/facets
  • foffset - facet offset, to enable paging
  • fprefix - limits facets to values that start with the supplied value
  Range based faceting is supported by using the SOLR parameters. For Example (formatted for readability):
  

  /occurrences/search?q=AdjustedSeedQuantity_i:[* TO *]
  &pageSize=0&facets=uncertainty
  &facet.range=ViabilitySummary_d
  &f.ViabilitySummary_d.facet.range.start=20.0
  &f.ViabilitySummary_d.facet.range.end=100.0
  &f.ViabilitySummary_d.facet.range.gap=10
  &facet.range=AdjustedSeedQuantity_i
  &f.AdjustedSeedQuantity_i.facet.range.start=0
  &f.AdjustedSeedQuantity_i.facet.range.end=100000
  &f.AdjustedSeedQuantity_i.facet.range.gap=50000

• POST query details: If you find that your q or wkt are too large or cumbersome to be passing around there is the facility to POST a query's detail and use a qid as a reference. This is particularly useful in working with WKT strings that may get too large to use a GET method.
  • Construction: /webportal/params
    POST service.
    Stores q and wkt parameters.
    Returns a short value that can be used as the initial q value in other services. e.g. q=qid:value
  • Test - a GET method to test if a short value is valid: /webportal/params/value Test if a short query parameter is valid.
    Returns true or false
  • Details - a GET method to return the query that is represented by the qid: /webportal/params/detailsvalue Returns a JSON representation of the query details that have been cached.
  You should only use the short query parameter in your subsequent searches and downloads if the "Test" service returns true.
• Occurrence listing: /occurrences/page - just shows the first 10 occurrences (for debug only)
• Occurrence view: /occurrence/{uuid} e.g. /occurrence/35b3ff3e-a9b9-4816-a3cf-8f16cf434fc7
• Occurrence comparison view: /occurrence/compare/{uuid} e.g. /occurrence/compare/35b3ff3e-a9b9-4816-a3cf-8f16cf434fc7
• Occurrence for taxon: /occurrences/taxon/{guid} e.g. /occurrences/taxon/urn:lsid:biodiversity.org.au:afd.taxon:7790064f-4ef7-4742-8112-6b0528d5f3fb
• Occurrence for collection: /occurrences/collections/{uid} e.g. /occurrences/collections/co11
• Occurrence for institution: /occurrences/institutions/{uid} e.g. /occurrences/institutions/in4
• Occurrence for data resource: /occurrences/dataResources/{uid}
• Occurrence for data provider: /occurrences/dataProviders/{uid}
• Occurrence for data hub: /occurrences/dataHubs/{uid} e.g. /occurrences/collections/dh1
• Occurrence download: /occurrences/download - needs request param definition
  The download will include all records that satisfy the q, fq and wkt parameters. The number of records for a data resource may be restricted based on a collectory configured download limit. Params:
  • q - the initial query. "q=*:*" will query anything, q="macropus" will do a free text search for "macropus", q=kingdom:Fungi will search for records with a kingdom of Fungi.
  • fq - filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi
  • wkt - filter polygon area to be applied to the original query. For information on Well known text, see this
  • email - the email address of the user requesting the download
  • reason - the reason for the download
  • file - the name to use for the fileto download
  • fields - a CSV list of fields to include in the download (contains a list of default)
  • extra - a CSV list of fields in include in addition to the "fields"
  • reasonTypeId - a mandatory value that indicates the reason for the download. See reasons for valid id's
  • fileType - the file format for the download. Valid values are csv and shp. If no value is supplied csv is assumed.
  • qa - A CSV list of record issues to include in the download. See assertions for possible values to include. By default it will include all applicable issues. To include no issue supply none as the value (eg &qa=none)

  Example: /occurrences/download?q=genus:Macropus

  A listing of fields that come in the download is available here.

• Occurrence download from index: /occurrences/index/download - has identical request params to the "Occurrence download".
  An index download differs by exporting the values from the index rather than the database. Index downloads are generally faster but they are restricted to values that are "stored" in the index. See /index/fields for information about the stored index. When database fields are supplied they are mapped to the appropriate index value.
  Fields that are not "stored" in the index are silently ignored in the download.
• Occurrence Count for Taxa: /occurrences/taxaCount
  This is a POST or GET service with the following parameters:
  • separator - the separator that will appear between taxon guids
  • guids - the list of separated taxon guids
  Returns a map of taxon guids with the corresponding occurrence count.
• Occurrence wms: /occurrences/wms - requires WMS parameters along with 'q' and 'fq' populated, if available
• Occurrences coordinates: /occurrences/coordinates - Displays a list of unique lat,lon that are used by the occurrences
• List of default facets for occurrence search: /search/facets
• The default facets for a search grouped by theme: /search/grouped/facets
• List of all available index fields: /index/fields - A field can be used in a search or facet if indexed=true. A field can be accessed in a search result if stored=true.
• Extra details about specific fields: /index/fields?fl=comma-separated-list-of-fields - This can be used to get a count of distinct terms a the supplied fields
  Example:
  /index/fields?fl=lat_long
• Facet based download: /occurrences/facets/download - requires a 'q' and optional 'fq' and one 'facets'. Optional Params:
  • count - set to true if you would like the count included
  • lookup - set to true if you would like the download include the scientific names and higher classification for the supplied guids. Downloads that include this param will take extra time as a lookup need to be performed
  • fsort - used to sort values in the file - either 'count' or 'index'
  • synonym - set to true if you want the lookup to include synonyms. Use with care as this will perform an additional lookup.
  
  This can be used to download distinct lists of species:
  • /occurrences/facets/download?q=collection_uid:co150&facets=species_guid&lookup=true - downloads a list of species guids and associated scientific names for collection co150
  • /occurrences/facets/download?q=collection_uid:co150&facets=raw_taxon_name - downloads a list of raw scientific names for collection co150
  • /occurrences/facets/download?q=collection_uid:co150&facets=species_guid&count=true - downloads a list of species guids and counts for collection co150
• Spatial Occurrence search: /occurrences/spatial - supports point-radius and wkt based searches. To search by wkt the wkt string can be supplied directly or via a gazetteer URL. Examples:
  • /occurrences/spatial?lat=-35.27&lon=149.15&radius=10
  • /occurrences/spatial?wkt=POLYGON((140:-37,151:-37,151:-26,140.1310:-26,140:-37))
  • /occurrences/spatial?url=https://spatial.ala.org.au/gazetteer/lga/Acton_(Australian_Capital_Territory).xml
• Static Species Density Heatmap - returns heatmap image
  • forceRefresh - will force regeneration of the image instead of using cached version. Default is false
  • forcePointsDisplay - force to use points instead of heatmap. Default is false
  • pointColour - the point colour to use in RGB e.g. &pointColour=0000ff. Default is 0000ff (blue)
  • colourByFq - colour by a facet value e.g. &colourByFq=genus:Acacia,genus:Eucalyptus will colour the dots by different values.
  • colours - how to colour the by facet values. Note colours and colourByFq must align. e.g &colours=ff0000,00ff00
  • pointHeatMapThreshold - used to sort values in the file - either 'count' or 'index'
  Example maps:
  • /density/map?q=Acacia
  • /density/map?q=Crimson+rosella
• Static Species Density Legend: - returns associated legend image (optional param forceRefresh=true will regenerate the image) Example maps:
  • /density/legend?q=*:*

Assertions

• List assertion codes: /assertions/codes
• Add an assertion: /occurrences/{uuid}/assertions/add
• Add an assertion using params: /occurrences/assertions/add?recordUuid={uuid}
• Delete an assertion: /occurrences/{uuid}/assertions/{assertionUuid}/delete
• Delete an assertion using params: /occurrences/assertions/delete?recordUuid={uuid}&assertionUuid={assertioniUuid}
• List assertions for occurrence: /occurrences/{uuid}/assertions/
• List assertions for occurrence with params: /occurrences/assertions?recordUuid={uuid}
• Add a bulk list of assertions via a POST: /bulk/assertions/add?apiKey={key}&userId={id}&userDisplayName={userDisplayName}&assertions={assertions}
  • apiKey - the shared key necessary for making edits to the system
  • userId - the id of the user to apply the assertions against
  • userDisplayName - the display name for the user that suppplied the assertions
  • assertions - a json string representation of a list of assertions, each assertion must have a recordUuid, code and comment. Example:
    [ {"recordUuid": "d2687ef5-7ce9-472b-b7cb-8d2ace2676e8", "code": "0", "comment": "a comment"}, {"recordUuid": "73aadf23-1fc2-478e-ae29-3a0646ddb3a3", "code": "0", "comment": "My next comment"} ]

Explore services

This section describes the services that can be used to explore a region or query. The Explore services provide the number of distinct species and total species counts for each of the species_groups for the supplied details. In the services listed below the following params can be supplied:

• lat - The latitude to limit the query by (must be used with lon and radius)
• lon - The longitude to limit the query by (must be used with lat and radius)
• radius - The radius to from lat,lon to limit the query by (must be used with lat and lon)
• q - The query which defaults to *:* when not supplied
• fq - The filter query

The available services:

• Retrieve all species groups and counts: /explore/groups
• Retrieve the counts for a specific group: /explore/counts/group/{group} -the first count is total number of occurrence, the second is the number of distinct species
• Download a list of species in a group: /explore/group/{group}/download
• Retrieve list of species and counts for a group: /explore/group/{group} - supports the additional parameters pageSize, start, sort, dir - to allow paging through the results
• Retrieve geojson cluster for group: /geojson/radius-points - supports an additional group parameter

Breakdowns

This section outlines the breakdown services that are available. These services are available for each of the different collectory types:

• collections
• institutions
• dataResources
• dataProviders
• dataHubs

In the services specified below {collectorytype} must be one of the above values.

• Breakdown based on limit: /breakdown/{collectorytype}/{uid}?max={max} Example:
  /breakdown/collections/co50?max=50
• Breakdown of a rank: /breakdown/{collectorytype}/{uid}?rank={rank} Example:
  /breakdown/dataResources/dr375?rank=class
• Breakdown at the supplied name and rank: /breakdown/{collectorytype}/{uid}?rank={rank}&name={name} Example:
  /breakdown/dataHubs/dh1?rank=phylum&name=Chordata

• Generic breakdown service is available for any query: /breakdown - available params
  • q - the initial query on which to perform the breakdown
  • fq - filters to be applied to the original query
  • max - the maximum number of names to return for the breakdown. The rank at which the breakdown will be determined based on this limit.
  • rank - the rank at which to perform the breakdown - if a name is specified in conjunction to this the breakdown will be performed at the next level further limiting the query
  • name - the scientific name to limit the breakdown to - needs a valid rank to be supplied

Administration

• Check for Read Only Mode: /admin/isReadOnly
• Modify Read Only Mode: /admin/modify?ro={true OR false}
• Reopen Index: /admin/modify?reopenIndex=true
• View Active Downloads: /active/download/stats

The remaining services in the section only support POST. All services must supply apiKey as a parameter.

• Optimise Index: /admin/index/optimise - This service will place the biocache-service in read only mode until the optimise has been completed.
  Example:
  curl --data "apiKey=KEY" https://biocache.ala.org.auhttps://biocache-service.sibbr.gov.br/biocache-service/admin/index/optimise
• Reindex Data Resource: /admin/index/reindex - reindexes occurrences modified after startDate for the supplied dataResource
  Extra Mandatory Parameters:
  
  • dataResource - The data resource UID to reindex
  • startDate - The earliest modification date to reindex.
  
  Example:
  curl --data "apiKey=KEY&dataResource=dr343&startDate=2011-07-01" https://biocache.ala.org.auhttps://biocache-service.sibbr.gov.br/biocache-service/admin/index/reindex

Miscellaneous

• Retrieve i18n mappings: /facets/i18n - supports requests for language specific properties, such as /facets/i18n_fr.properties (not currently provided, contact us if required)
• Is Australian test: /australian/taxon/{guid} - tests to see if the supplied GUID; occurs in Australia, has an Australian LSID or is NOT Australian. Example:
  /australian/taxon/urn:lsid:biodiversity.org.au:afd.taxon:aa745ff0-c776-4d0e-851d-369ba0e6f537
• Images: /images/taxon/{guid} - obtains a list of occurrence images for the supplied species taxon GUID. Example:
  /images/taxon/urn:lsid:biodiversity.org.au:afd.taxon:dbc44b63-9611-44a8-af58-a29caea777b6
• Retrieve Deleted Record UUIDs: /occurrence/deleted?date=yyyy-MM-dd. This service will return a list of occurrence UUIDs that have been deleted since the supplied date (inclusive).

Parsing Webservices

• Match darwin core terms: /parser/matchTerms - accepts a POST JSON body. Examples:
  • ["scientific name", "latitude"]
    will return
    ["scientificName", "decimalLatitude"]
  • ["Macropus rufus", "12.2", "149.0"]
    will return
    ["species", "decimalLatitude","decimalLongitude"]
• Are darwin core terms? : /parser/areDwcTerms - accepts a POST JSON body. Examples:
  • ["scientific name", "latitude"]
    will return
    true
  • ["Macropus rufus", "12.2", "149.0"]
    will return
    false
• Ad hoc processing: /process/adhoc - accepts a POST JSON body. Examples:
  • { "scientificName": "Macropus rufus" }
    will return
    {"assertions":[{"comment":"Missing basis of record","problemAsserted":true,"code":20001,"name":"missingBasisOfRecord","uuid":"bf9dc7a0-9918-4ae1-ac2c-2cd9729a1dc0"},{"comment":"No date information supplied","problemAsserted":true,"code":30008,"name":"missingCollectionDate","uuid":"fe473a55-89ca-4803-b8b3-c050b930d287"}],"values":[{"processed":"Macropus rufus","raw":"","name":"species"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:065f1da4-53cd-40b8-a396-80fa5c74dedd","raw":"","name":"phylumID"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:e9e7db31-04df-41fb-bd8d-e0b0f3c332d6","raw":"","name":"classID"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:6d8079f1-edc9-4aab-aabd-232a32b42471","raw":"","name":"orderID"},{"processed":"Mammalia","raw":"","name":"classs"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:72a1c39f-2435-4c28-a680-714b69ded6f9","raw":"","name":"familyID"},{"processed":"2161700","raw":"","name":"left"},{"processed":"Chordata","raw":"","name":"phylum"},{"processed":"species","raw":"","name":"taxonRank"},{"processed":"Animalia","raw":"","name":"kingdom"},{"processed":"Macropus rufus","raw":"Macropus rufus","name":"scientificName"},{"processed":"Macropus","raw":"","name":"genus"},{"processed":"7000","raw":"","name":"taxonRankID"},{"processed":"Diprotodontia","raw":"","name":"order"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:aa745ff0-c776-4d0e-851d-369ba0e6f537","raw":"","name":"taxonConceptID"},{"processed":"[\"Animals\",\"Mammals\"]","raw":"","name":"speciesGroups"},{"processed":"Macropodidae","raw":"","name":"family"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:aa745ff0-c776-4d0e-851d-369ba0e6f537","raw":"","name":"speciesID"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:558a729a-789b-4b00-a685-8843dc447319","raw":"","name":"genusID"},{"processed":"2161701","raw":"","name":"right"},{"processed":"urn:lsid:biodiversity.org.au:afd.taxon:4647863b-760d-4b59-aaa1-502c8cdf8d3c","raw":"","name":"kingdomID"},{"processed":"Red Kangaroo","raw":"","name":"vernacularName"}]}

Mapping Services (/mapping)

These services will include all records that satisfy the q, fq and wkt parameters.
• q - the initial query
• fq - filters to be applied to the original query
• wkt - filter polygon area to be applied to the original query
• fl - a comma separated list of fields to include (contains a list of default)
• pageSize - download limit (may be overridden)
• Short Query Parameters:
  • Construction: /mapping/params
    POST service.
    Stores q and wkt parameters.
    Returns a short value that can be used as the initial q value in other services for mapping. e.g. q=qid:value
  • Test: /webportal/params/value Test if a short query parameter is valid.
    Returns true or false
  • Details: /webportal/params/detailsvalue Returns a JSON representation of the query details that have been cached.
• Occurrences Bounding Box: /mapping/bbox
  Returns CSV of bounding box of occurrences
• Data Providers /webportal/dataProviders
• Species List:
  • Get species list: /mapping/species
  • Get species list as CSV: /webportal/species.csv
• Occurrences:
  • Get occurrences: /mapping/occurrences
  • Get occurrences as gzipped CSV: /webportal/occurrences.gz

WMS Services

These services are suitable for use with a OGC client or an OGC friendly API like openlayers. Examples of use are available here

• GetCapabilities: /ogc/ows - generates a GetCapabilities document based on a query that can be used in an OGC client. The GetCapabilities gives a hierarchial taxonomic listing of taxa.
  • q - SOLR query q e.g. q=genus:Macropus
  • fq - SOLR query fq e.g. fq=genus:Macropus
  • spatiallyValidOnly - only include spatially valid coordinates when deriving taxa list
  • marineSpecies - only include marine species when deriving taxa list
  • terrestrialSpecies - only include terrestrial species when deriving taxa list
  • limitToFocus - only include species that have occurred with the focus area (e.g. Australia) when deriving taxa list
  • useSpeciesGroups - use species groups and then order to species when deriving taxa list
• GetMetadata - Marine Community Profile : /ogc/getMetadata
  • q - SOLR query q e.g. q=genus:Macropus
• GetFeatureInfo : /ogc/getFeatureInfo
  • x - x coordinate within tile
  • y - y coordinate within tile
  • WIDTH - width in pixels
  • HEIGHT - height in pixels
  • BBOX - EPSG900913 or EPSG:4326 bounding box. e.g. &BBOX=12523443.0512,-2504688.2032,15028131.5936,0.3392000021413
  • SRS - only supports EPSG900913 or EPSG:4326
  • QUERY_LAYERS - layers to query comma separated. E.g. &QUERY_LAYERS=genus:Macropus,genus:Acacia
• GetMap: /mapping/wms/reflect
  • BBOX - EPSG900913 bounding box. e.g. &BBOX=12523443.0512,-2504688.2032,15028131.5936,0.3392000021413
  • WIDTH - width in pixels
  • HEIGHT - height in pixels
  • CQL_FILTER - query parameter
  • ENV - additional parameters. e.g. ENV=color%3Acd3844%3Bsize%3A3%3Bopacity%3A0.8
    • color - hex RGB values. e.g. colour:cd3844
    • size - radius of points in pixels
    • opacity - opacity value 0 - 1
    • sel - fq parameter applied to CQL_FILTER. Matching occurrences will be highlighted on the map in a Red circle
    • uncertainty - presence of the uncertainty parameter draws uncertainty circles to a fixed maximum of 30km
    • colormode - facet colouring type.
      • -1 - (default) use color value
      • grid - map as density grid. Grid cells drawn are not restricted to within any query WKT parameters.
      • facetname - colour as categories in a facet
      • facetname,cutpoints - colour as range in a facet using the supplied comma separated cutpoints. 4 to 10 values are required. Include minimum and maximum. Minimum and maximum values do not need to be accurate. e.g. colormode:year,1800,1900,1950,1970,1990,2010
      
      
  • STYLE - e.g. STYLE=color:cd3844;size=1;opacity=0.8
• Legend: /mapping/legend - Get a CSV legend.
  Parameters:
  • q - CQL_FILTER value
  • cm - ENV colormode value
  Contains columns:
  • name - legend item name
  • red - 0-255
  • green - 0-255
  • blue - 0-255
  • count - number of occurrences for this legend category in the q parameter
• Publication map image /mapping/wms/image
  e.g. /webportal/wms/image?extents=142,-45,151,-38&q=macropus&format=jpg&dpi=300&pradiusmm=1&popacity=0.8&pcolour=0000FF&widthmm=150&scale=on&baselayer=aus2
  • extents - EPSG4326 bounding box. Valid between -180 and +180 longitude. Latitude is best between -85 and +85. e.g. &extents=-180,-85,180,85
  • dpi - (optional) set the image DPI. e.g. &dpi=300
  • widthmm - (optional) width in mm, integer
  • pradiusmm - (optional) species point radius in mm, integer
  • pcolour - (optional) species point colour as hexadecimal RRGGBB.
  • popacity - (optional) species point opacity 0 - 1.
  • format - (optional) output format, png or jpg
  • scale - (optional) show scale line on the image. Not suitable for large DPI values. e.g. &scale=on
  • baselayer - (optional) ALA: base layer to use from https://spatial.ala.org.au/geoserver E.g. &baselayer=aus1
  • fileName - (optional) the name of the file to pass back in content headers

Outlier information

These are webservices for reporting the on outlier details for records.

• Outlier test information for species
  e.g. /outlierInfo/urn:lsid:biodiversity.org.au:afd.taxon:0c139726-2add-4abe-a714-df67b1d4b814.json (Mountain thornbill)
• Outlier record details
  e.g. /outlier/record/b07bbac2-22d7-4c8a-8d61-4be1ab9e0d09 (A Mountain thornbill outlier)

Duplicate Detection information

This is the webservice for reporting the details of a duplicate. It indicates the criteria that was used to determine the duplcates.

• /duplicates/[representative record uuid]
  eg /duplicates/3cde1570-7a38-4a58-b121-e95c35585a29

Assertion Query

A assertion query allows a group of occurrences to have the same assertion applied at once. The occurrences that make up the assertions are identified by a reusable query. New occurrences that satisfy the query will have the assertion added the next time it is applied. The only supported query type is based on a wkt area and species name as defined below. In the future we may support custom queries.

These are webservices for working with the query assertions.

• Add Assertion Query
  To add a query POST a JSON body to the following URL: /assertions/query/add.
  Example JSON body
  { "id": 4, "apiKey":"sharedkey", "status": "modified", "comment": "mah comment", "classification": "breeding", "lastModified": "2012-07-23T16:34:34", "species": "Motacilla flava", "user": { "email": "test@test.com", "authority": 1234 }, "area": "MULTIPOLYGON(((20 10,19.8078528040323 8.04909677983872,19.2387953251129 6.17316567634911,18.3146961230255 4.44429766980398,17.0710678118655 2.92893218813453,15.555702330196 1.68530387697455,13.8268343236509 0.761204674887138,11.9509032201613 0.192147195967697,10 0,8.04909677983873 0.192147195967692,6.17316567634912 0.761204674887125,4.444297669804 1.68530387697453,2.92893218813454 2.92893218813451,1.68530387697456 4.44429766980396,0.761204674887143 6.17316567634908,0.192147195967701 8.04909677983869,0 9.99999999999997,0.192147195967689 11.9509032201612,0.761204674887118 13.8268343236509,1.68530387697453 15.555702330196,2.9289321881345 17.0710678118654,4.44429766980394 18.3146961230254,6.17316567634906 19.2387953251129,8.04909677983868 19.8078528040323,9.99999999999996 20,11.9509032201612 19.8078528040323,13.8268343236509 19.2387953251129,15.555702330196 18.3146961230255,17.0710678118655 17.0710678118655,18.3146961230254 15.555702330196,19.2387953251129 13.8268343236509,19.8078528040323 11.9509032201613,20 10)))" }
• View Assertion Query details
  This service will return the assertion information. It will NOT return the details of the query.
  /assertions/query/{uuid}
• View Query Assertions details
  This service will return the information for all the listed assertions. It will NOT return the details of the queries.
  /assertions/queries/{csv list of uuid}
• Apply Query Assertion
  This service will apply the supplied query assertion against the biocache records.
  /assertions/query/{uuid}/apply

Endemism Services

These are webservices for reporting information about species that are endemic to specific areas. Endemism is determined by comparing the list of species that occur inside to those that occur outside the supplied area. There is a "feature" where by species that occur on the border of the area are considered to be inside and outside the region.

• Count of Distinct Endemic species: /explore/counts/endemic
  Example: /explore/counts/endemic?q=institution_code:CSIRO&wkt=POLYGON((140:-37,151:-37,151:-26,140.131:-26,140:-37))&facets=species_guid
• Endemic Species: /explore/endemic/species
  Example: /explore/endemic/species?q=institution_code:CSIRO&wkt=POLYGON((140:-37,151:-37,151:-26,140.131:-26,140:-37))&facets=species_guid
• Endemic Species CSV: /explore/endemic/species.csv - This service will return extra information about the species that are endemic.
  Example: /explore/endemic/species.csv?q=institution_code:CSIRO&wkt=POLYGON((140:-37,151:-37,151:-26,140.131:-26,140:-37))

The services above support the following params:

• q - the initial query. "q=*:*" will query anything, q="macropus" will do a free text search for "macropus", q=kingdom:Fungi will search for records with a kingdom of Fungi.
  For a listing of the fields that can be queried in a q=INDEXEDFIELD:VALUE fashion, see /index/fields
  This will restrict the records that are considered in then region. For example this could allow people to restrict the service to endemic birds.
• fq - filters to be applied to the original query. These are additional params of the form fq=INDEXEDFIELD:VALUE e.g. fq=kingdom:Fungi.
  Again, see /index/fields for all the fields that a queryable.
• wkt - The Well Known Text Area in which to provide the endemic species. For information on Well known text, see this
• facets - the field on which to based the species list. This can be taxon_concept_lsid or species_guid.

The endemism services support the use of POSTED q and wkt values. See POST Query Details for more information.

Free text search of occurrence records (will return JSON)

Build Info

/buildInfo