NetPhyD REST API - Documentation

Authentication

Authentication is managed with OpenId Connect and bearer tokens.

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}
  • /api/v1/{portalId}/people/cache/evict
  • GET POST
  • GET
  • 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}
  • /api/v1/{portalId}/samples/user/foreign
  • GET POST
  • GET
  • GET
  • DELETE GET
  • GET
  • POST
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}
  • /api/v1/{portalId}/users/{email}/roles/{role}
  • GET
  • GET
  • DELETE
  • DELETE POST

Data Types

JSON

type description
AbstractComment
AddRoleResponse
Address
Amount
Area Covered area in square meters
Availability
Base
BaseInt
BaseResponse
BaseUUID
BloomingSprouts
ChronoUnit
CollectionsSummary
Contact
CoordinateSystem
CountResponse
DateEntry
DeleteUserResponse
DeletedResponse
Document
DocumentType
ExportPolicy
FailureResponse
Filter
FilterResponse
FrequencyDistribution
FrequencyDistributionResponse
Herbarium
Institution
JobStatus
Language
LayerName
LifeStage
Link Value object for links.
Locality
Location
MTB
MTBResponse
Makropter
MediaResponse
MediaUpload
MetaData Information about the request
NumericAmountAccuracy Adds quantity information to the field numericAmount
ObfuscationPolicy
Occurrence
OccurrenceCentroid
OccurrenceCentroidsSliceResponse
OccurrenceComment
OccurrenceCommentsSliceResponse
OccurrenceExport
OccurrenceExportResponse
OccurrenceExportStatusResponse
OccurrenceExportsInfoResponse
OccurrenceField
OccurrenceFieldConfig
OccurrenceFieldConfigResponse
OccurrenceImport
OccurrenceImportStatusResponse
OccurrenceImportsInfoResponse
OccurrenceResponse
OccurrenceSliceResponse
OccurrenceStatusCentroid
OccurrenceStatusCentroidsSliceResponse
OccurrenceStreamResponse
Operation
Permission
Person
PersonResponse
PersonSliceResponse
Portal
PortalBase
PortalBaseResponse
PortalBoundsResponse
PortalConfigResponse
PortalConfiguration
PortalSliceResponse
PortalTagsResponse
Position Describes the position of a sample.

Positions do not have an id. They are not a stand alone entity.

PositionType
Publication
Quantity
RecordStatus
RedListStatus
Reproduction
Role
Sample
SampleBase
SampleComment
SampleCommentsSliceResponse
SampleField
SampleFieldConfig
SampleFieldConfigResponse
SampleMethod
SampleResponse
SampleSliceResponse
SampleWithCreator
SaveOrUpdateResponse
ServiceInfo
ServiceInfoResponse
SettlementStatus
SettlementStatusFukarek
Sex
SliceResponse
StaticMapStyle
StreamResponse
Survey
SurveyBase
SurveyBaseResponse
SurveyField
SurveyFieldConfig
SurveyFieldConfigResponse
SurveysSliceResponse
TaxaList
TaxaListResponse
TaxaListSliceResponse
TaxaResponse
Taxon
TaxonBase
TaxonBaseSliceResponse
TaxonField
TaxonFieldConfig
TaxonFieldConfigResponse
TaxonResponse
TaxonSliceResponse
TermsAndConditonsAcceptResponse
TextResponse
Token
TokenResponse
TranslationResponse
User
UserAuth
UserInfo Information about a user.
UserInfoResponse
UserSliceResponse
VagueDate Describes the date. Allows vague dates like in June 2017.
VagueDateType The type of the date
Validation
ValidationStatus
Value A value for enumerated data.
Vitality

XML

Default Namespace (schema)
type description
chronoUnit
address
collectionsSummary
contact
institution
location
abstractComment
availability
dateEntry
document
documentType
frequencyDistribution
herbarium
jobStatus
language
locality
MTB
obfuscationPolicy
occurrence
amount
area Covered area in square meters
bloomingSprouts
lifeStage
makropter
numericAmountAccuracy Adds quantity information to the field numericAmount
quantity
recordStatus
reproduction
settlementStatus
settlementStatusFukarek
sex
validationStatus
vitality
occurrenceCentroid
occurrenceComment
occurrenceExport
occurrenceImport
occurrenceStatusCentroid
person
portal
portalBase
portalConfiguration
position Describes the position of a sample.

Positions do not have an id. They are not a stand alone entity.

positionType
publication
sample
sampleBase
sampleMethod
sampleComment
sampleWithCreator
serviceInfo
survey
surveyBase
taxaList
taxon
redListStatus
taxonBase
user
userInfo Information about a user.
vagueDate Describes the date. Allows vague dates like in June 2017.
vagueDateType The type of the date
validation
value A value for enumerated data.
coordinateSystem
exportPolicy
filter
layerName
operation
permission
role
staticMapStyle
occurrenceField
occurrenceFieldConfig
sampleField
sampleFieldConfig
surveyField
surveyFieldConfig
taxonField
taxonFieldConfig
addRoleResponse
baseResponse
countResponse
deleteUserResponse
deletedResponse
failureResponse
filterResponse
frequencyDistributionResponse
MTBResponse
mediaResponse
occurrenceCentroidsSliceResponse
occurrenceCommentsSliceResponse
occurrenceExportResponse
occurrenceExportStatusResponse
occurrenceExportsInfoResponse
occurrenceFieldConfigResponse
occurrenceImportStatusResponse
occurrenceImportsInfoResponse
occurrenceResponse
occurrenceSliceResponse
occurrenceStatusCentroidsSliceResponse
occurrenceStreamResponse
personResponse
personSliceResponse
portalBaseResponse
portalBoundsResponse
portalConfigResponse
portalSliceResponse
portalTagsResponse
sampleCommentsSliceResponse
sampleFieldConfigResponse
sampleResponse
sampleSliceResponse
saveOrUpdateResponse
serviceInfoResponse
sliceResponse
streamResponse
surveyBaseResponse
surveyFieldConfigResponse
surveysSliceResponse
taxaListResponse
taxaListSliceResponse
taxaResponse
taxonBaseSliceResponse
taxonFieldConfigResponse
taxonResponse
taxonSliceResponse
termsAndConditonsAcceptResponse
textResponse
tokenResponse
translationResponse
userInfoResponse
userSliceResponse
base
baseInt
baseUUID
mediaUpload
metaData Information about the request
token
userAuth
Namespace http://www.w3.org/2005/Atom (schema)
type description
link Value object for links.