Environment Controller

Create or update one or multiple entities.

Changed on

A uuid will be generated for any entity that doesn't have one yet. Posting entities without uuid multiple times will also create them multiple times.

post/environments/push

Request

  • Base URL
    /sormas-rest (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /sormas-rest/environments/push
  • Auth
    none declared

Request body

changeDatestring date-time
creationDatestring date-time
deletedboolean
deletionReason'GDPR' | 'DELETION_REQUEST' | 'CREATED_WITH_NO_LEGAL_REASON' | 'TRANSFERRED_RESPONSIBILITY' | 'DUPLICATE_ENTRIES' | 'OTHER_REASON'
descriptionstring
environmentMedia'WATER' | 'SOIL_ROCK' | 'AIR' | 'BIOTA' | 'VECTORS' required
environmentNamestring required
externalIdstring
inJurisdictionboolean
infrastructureDetails'SEPTIC_TANK' | 'LATRIN' | 'TOILET' | 'MANHOLE' | 'WELLS' | 'SURFACE_WATER' | 'OPEN_DRAIN' | 'OTHER' | 'UNKNOWN'
investigationStatus'PENDING' | 'DONE' | 'DISCARDED' required
otherDeletionReasonstring
otherInfrastructureDetailsstring
otherWaterTypestring
otherWaterUsestring
pseudonymizedboolean
reportDatestring date-time required
uuidstring
vectorType'MOSQUITOS' | 'TICKS'
waterType'WASTEWATER' | 'GROUNDWATER' | 'SURFACE_WATER' | 'PRECIPITATION' | 'OTHER' | 'UNKNOWN'
waterUseobject

Response

Array of responses, matching the posted array of entities. Provides an HTML status code for every entity and an optional body (e.g. a string with an error message).

bodyobject
statusCodeinteger

Changes

  • c409502e0543Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new VECTORS enum value to the request property /

  • 8fcd6fbef5e6Revision changes
    • breaking

      removed the enum value VECTORS of the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /