Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
InfoResource
  • /api/v1/info
  • /api/v1/info/serviceUser
  • GET
  • GET
Information about the service
OccurrenceCommentsResource
  • /api/v1/{portalId}/occurrences/{uuid}/comments
  • /api/v1/{portalId}/occurrences/{uuid}/comments/count
  • GET POST
  • GET
OccurrenceExportResource
  • /api/v1/{portalId}/occurrences/export
  • /api/v1/{portalId}/occurrences/export/count
  • /api/v1/{portalId}/occurrences/export/large
  • /api/v1/{portalId}/occurrences/export/{exportId}
  • /api/v1/{portalId}/occurrences/export/{exportId}/status
  • GET POST
  • GET
  • POST
  • DELETE GET
  • GET
Resource for the export of occurrences.

The workflow will be

  1. Select data with OccurrenceExportResource #find(OccurrenceFilter)
  2. Check with the OccurrenceExportResponse#getExportId() retrieved export id if the export is finished with OccurrenceExportResource #getStatus(UUID), or wait for an email.
  3. Download the export at OccurrenceExportResource #getExport(UUID)
  4. Delete an export with the OccurrenceExportResponse#getExportId() retrieved export id
OccurrenceImportResource
  • /api/v1/{portalId}/import
  • /api/v1/{portalId}/import/count
  • /api/v1/{portalId}/import/csv
  • /api/v1/{portalId}/import/{id}
  • /api/v1/{portalId}/import/{importId}
  • /api/v1/{portalId}/import/csv/template
  • /api/v1/{portalId}/import/csv/{importId}
  • /api/v1/{portalId}/import/{importId}/status
  • /api/v1/{portalId}/import/csv/template/help
  • /api/v1/{portalId}/import/csv/{importId}/errors
  • GET POST
  • GET
  • POST
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • GET
  • GET
OccurrenceMediaResource
  • /api/v1/{portalId}/occurrences/{uuid}/media
  • /api/v1/{portalId}/occurrences/{uuid}/media/image
  • DELETE
  • POST
OccurrenceResource
  • /api/v1/{portalId}/occurrences
  • /api/v1/{portalId}/occurrences/count
  • /api/v1/{portalId}/occurrences/meta
  • /api/v1/{portalId}/occurrences/stream
  • /api/v1/{portalId}/occurrences/{uuid}
  • /api/v1/{portalId}/occurrences/centroids/{taxonId}
  • /api/v1/{portalId}/occurrences/meta/{surveyId}
  • /api/v1/{portalId}/occurrences/statusCentroids/{taxonId}
  • /api/v1/{portalId}/occurrences/{uuid}/herbarysheet
  • /api/v1/{portalId}/occurrences/{uuid}/validate
  • /api/v1/{portalId}/occurrences/centroids/count/{taxonId}
  • GET OPTIONS POST
  • GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
Resource to access data on a Occurrence level. All access needs an authenticated user.
OccurrenceStatsResource
  • /api/v1/{portalId}/occurrences/stats/createdPerDay
  • /api/v1/{portalId}/occurrences/stats/createdPerMonth
  • /api/v1/{portalId}/occurrences/stats/createdPerWeek
  • GET
  • GET
  • GET
Resource to access statistics on a Occurrence level.
PeopleResource
  • /api/v1/{portalId}/people
  • /api/v1/{portalId}/people/count
  • /api/v1/{portalId}/people/{id}
  • GET POST
  • GET
  • GET
PortalResource
  • /api/v1
  • /api/v1/count
  • /api/v1/{portalId}
  • /api/v1/{portalId}/associated
  • /api/v1/{portalId}/bounds
  • /api/v1/{portalId}/config
  • /api/v1/{portalId}/filter
  • /api/v1/{portalId}/tags
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
Informations about the portals
SampleCommentsResource
  • /api/v1/{portalId}/samples/{uuid}/comments
  • /api/v1/{portalId}/samples/{uuid}/comments/count
  • GET POST
  • GET
SamplesResource
  • /api/v1/{portalId}/samples
  • /api/v1/{portalId}/samples/count
  • /api/v1/{portalId}/samples/meta
  • /api/v1/{portalId}/samples/{uuid}
  • /api/v1/{portalId}/samples/meta/{surveyId}
  • GET POST
  • GET
  • GET
  • DELETE GET
  • GET
SurveysResource
  • /api/v1/{portalId}/surveys
  • /api/v1/{portalId}/surveys/count
  • /api/v1/{portalId}/surveys/meta
  • /api/v1/{portalId}/surveys/{id}
  • GET POST
  • GET
  • GET
  • GET
TaxaListResource
  • /api/v1/{portalId}/taxalist
  • /api/v1/{portalId}/taxalist/count
  • /api/v1/{portalId}/taxalist/{id}
  • GET
  • GET
  • GET
TaxaResource
  • /api/v1/{portalId}/taxa
  • /api/v1/{portalId}/taxa/count
  • /api/v1/{portalId}/taxa/meta
  • /api/v1/{portalId}/taxa/{id}
  • /api/v1/{portalId}/taxa/meta/{surveyId}
  • /api/v1/{portalId}/taxa/{id}/coveredMTB
  • /api/v1/{portalId}/taxa/{id}/coveredMTBFiltered
  • /api/v1/{portalId}/taxa/{id}/evict
  • /api/v1/{portalId}/taxa/{id}/synonyms
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
TermsAndConditionsResource
  • /api/v1/{portalId}/tc/accept
  • /api/v1/{portalId}/tc/acceptance
  • /api/v1/{portalId}/tc/privacy
  • /api/v1/{portalId}/tc/toc
  • POST
  • GET
  • GET
  • GET
TokenResource
  • /api/v1/security/token
  • POST
Handling of access tokens
TranslationResource
  • /api/v1/{portalId}/translation/{languageTag}
  • /api/v1/{portalId}/translation/{languageTag}/{key}
  • GET
  • GET
Resource for dealing with translations
UsersResource
  • /api/v1/{portalId}/users
  • /api/v1/{portalId}/users/count
  • /api/v1/{portalId}/users/{email}/roles/{role}
  • GET
  • GET
  • DELETE POST