CDM Occurrence Search API

This web service endpoint provides occurrence information corresponding to a specific (accepted) taxon uuid.

The request parameters are :

  • 'taxonUuid' [mandatory] : this has to be the taxon UUID.
  • 'pageSize' [optional, default value = 50] : number results per page to display.
  • 'pageNumber' [optional, default value = 0] : number of the page to display.

The response format can be set by appending the format extension to the service endpoint. Currently this web service supports JSON (fully implemented) and XML (partially implemented).

The response objects returned by this web service endpoint have the following structure:

  • request
    • query : the taxon UUID as input.
  • response
    • acceptedTaxon : name of the accepted taxa corresponding to the requested taxon uuid.
    • acceptedTaxonUuid : input taxon uuid.
    • accessionNumber : accession number for the current occurrence.
    • barcode : barcode number for the current occurrence.
    • catalogNumber : catalog number (unitID) for the current occurrence.
    • collection : collection identifier where the occurrence is stored.
    • collector: collector name.
    • depth: absolute depth value or minimum depth if maxDepth is not null.
    • elevation: absolute elevation value or minimum elevation if maxElevation is not null.
    • endGatheringDate : end gathering or observation date.
    • fieldNotes : notes from the collector.
    • fieldNumber : number assigned by the collection.
    • institution : institution identifier where the occurrence is stored.
    • kindOfUnit : Part(s) of organism or class of materials represented by this unit. (e.g. fruits, seeds, tissue, etc)
    • location : location information corresponding to the occurrence, which includes,
      • country : country where the occurrence was gathered or observed.
      • decimalLatitude : latitude (in decimal) where the occurrence was gathered or observed.
      • decimalLongitude : longitude (in decimal) where the occurrence was gathered or observed.
      • errorRadius : error radius for the coordinates measurement.
      • locality: locality where the occurrence was gathered or observed
      • referenceSystem : GPS reference system.
    • maxDepth : maximum depth.
    • maxElevation : maximum elevation.
    • publicationDate : occurrence publication date.
    • rights : list of property rights associated with the resource, including intellectual property rights.
    • sources: list of paper, publications, urls from where the occurrence was extracted from.
    • startGatheringDate : start gathering or observation date.
    • type : type of specimen or observation described by the collector.
    • unitCount : number of units associated with the occurrence

Features:

  • One query per web service call.

Example Requests :

Example Responses :

  • Base UUID search : taxonUuid=aabef285-c8f7-4bee-a703-cfc7e4a70075 [back]
    {
    
        "count": 1,
        "currentIndex": 0,
        "firstRecord": 1,
        "indices": [
            0
        ],
        "lastRecord": 1,
        "nextIndex": 0,
        "pageSize": 50,
        "pagesAvailable": 1,
        "prevIndex": 0,
        "records": [
            {
                "acceptedTaxon": "Chenopodium album L.",
                "acceptedTaxonUuid": "aabef285-c8f7-4bee-a703-cfc7e4a70075",
                "accessionNumber": "",
                "barcode": "",
                "catalogNumber": "",
                "collection": "National Botanic Garden of Belgium",
                "collector": "Quarré",
                "depth": null,
                "elevation": null,
                "endGatheringDate": "",
                "fieldNotes": "",
                "fieldNumber": "3508",
                "institution": "",
                "kindOfUnit": "",
                "location": {
                    "country": "Zaire",
                    "decimalLatitude": null,
                    "decimalLongitude": null,
                    "errorRadius": null,
                    "locality": "vallée de la Karavia",
                    "referenceSystem": ""
                },
                "maxDepth": null,
                "maxElevation": null,
                "publicationDate": "",
                "rights": [ ],
                "sources": [ ],
                "startGatheringDate": "",
                "type": "PreservedSpecimen",
                "unitCount": null
            }
        ],
        "suggestion": ""
    
    }
    
  • UUID search with paging : taxonUuid=95402484-06cc-4284-a84c-193be51489ea&pageNumber=1&pageSize=2 [back]
    {
    
        "count": 11,
        "currentIndex": 1,
        "firstRecord": 3,
        "indices": [
            0,
            1,
            2,
            3
        ],
        "lastRecord": 4,
        "nextIndex": 2,
        "pageSize": 2,
        "pagesAvailable": 6,
        "prevIndex": 0,
        "records": [
            {
                "acceptedTaxon": "Chenopodium ambrosioides L.",
                "acceptedTaxonUuid": "95402484-06cc-4284-a84c-193be51489ea",
                "accessionNumber": "",
                "barcode": "",
                "catalogNumber": "",
                "collection": "",
                "collector": "",
                "depth": null,
                "elevation": null,
                "endGatheringDate": "",
                "fieldNotes": "",
                "fieldNumber": "",
                "institution": "",
                "kindOfUnit": "",
                "location": {
                    "country": "",
                    "decimalLatitude": null,
                    "decimalLongitude": null,
                    "errorRadius": null,
                    "locality": "Barranco d'Anavigo",
                    "referenceSystem": ""
                },
                "maxDepth": null,
                "maxElevation": null,
                "publicationDate": "1908",
                "rights": [ ],
                "sources": [
                    "PlaziCDMsync ",
                    "http://plazi.cs.umb.edu/GgServer/cdmSync/FE9CB87035C15D9328FF7CE6DEC573DD?cacheControl=force ",
                    "Charles Joseph Pitard and Louis Proust - Chenopodieae in Les îles Canaries. Flore de l'archipel. 1908 "
                ],
                "startGatheringDate": "",
                "type": "DerivedUnit",
                "unitCount": null
            },
            {
                "acceptedTaxon": "Chenopodium ambrosioides L.",
                "acceptedTaxonUuid": "95402484-06cc-4284-a84c-193be51489ea",
                "accessionNumber": "",
                "barcode": "",
                "catalogNumber": "",
                "collection": "",
                "collector": "",
                "depth": null,
                "elevation": null,
                "endGatheringDate": "",
                "fieldNotes": "",
                "fieldNumber": "",
                "institution": "",
                "kindOfUnit": "",
                "location": {
                    "country": "",
                    "decimalLatitude": null,
                    "decimalLongitude": null,
                    "errorRadius": null,
                    "locality": "Laguna",
                    "referenceSystem": ""
                },
                "maxDepth": null,
                "maxElevation": null,
                "publicationDate": "",
                "rights": [ ],
                "sources": [
                    "PlaziCDMsync ",
                    "Charles Joseph Pitard and Louis Proust - Chenopodieae in Les îles Canaries. Flore de l'archipel. 1908 ",
                    "http://plazi.cs.umb.edu/GgServer/cdmSync/FE9CB87035C15D9328FF7CE6DEC573DD?cacheControl=force "
                ],
                "startGatheringDate": "",
                "type": "DerivedUnit",
                "unitCount": null
            }
        ],
        "suggestion": ""
    
    }