Sample 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/samples/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/samples/push
  • Auth
    none declared

Request body

additionalTestingRequestedboolean
changeDatestring date-time
commentstring
creationDatestring date-time
deletedboolean
deletionReason'GDPR' | 'DELETION_REQUEST' | 'CREATED_WITH_NO_LEGAL_REASON' | 'TRANSFERRED_RESPONSIBILITY' | 'DUPLICATE_ENTRIES' | 'OTHER_REASON'
fieldSampleIDstring
inJurisdictionboolean
labDetailsstring
labSampleIDstring
noTestPossibleReasonstring
otherDeletionReasonstring
ownershipHandedOverboolean
pathogenTestResult'INDETERMINATE' | 'PENDING' | 'NEGATIVE' | 'POSITIVE' | 'NOT_DONE' | 'NOT_APPLICABLE'
pathogenTestingRequestedboolean
pseudonymizedboolean
receivedboolean
receivedDatestring date-time
reportDateTimestring date-time required
reportLatnumber double
reportLatLonAccuracynumber float
reportLonnumber double
requestedAdditionalTestsstring[]
requestedOtherAdditionalTestsstring
requestedOtherPathogenTestsstring
requestedPathogenTestsstring[]
sampleDateTimestring date-time required
sampleMaterial'BLOOD' | 'DRY_BLOOD' | 'SERA' | 'STOOL' | 'THROAT_ASPIRATE' | 'NASAL_SWAB' | 'THROAT_SWAB' | 'NP_SWAB' | 'RECTAL_SWAB' | 'CEREBROSPINAL_FLUID' | 'CRUST' | 'TISSUE' | 'URINE' | 'CORNEA_PM' | 'SALIVA' | 'URINE_PM' | 'NUCHAL_SKIN_BIOPSY' | 'BIOPSY' | 'SPUTUM' | 'ENDOTRACHEAL_ASPIRATE' | 'BRONCHOALVEOLAR_LAVAGE' | 'BRAIN_TISSUE' | 'ANTERIOR_NARES_SWAB' | 'OP_ASPIRATE' | 'NP_ASPIRATE' | 'PLEURAL_FLUID' | 'NASOPHARYNGEAL_LAVAGE' | 'OROPHARYNGEAL_SWAB' | 'AMNIOTIC_FLUID' | 'CLINICAL_SAMPLE' | 'PERITONEAL_FLUID' | 'SYNOVIAL_FLUID' | 'EDTA_WHOLE_BLOOD' | 'INTESTINAL_FLUID' | 'DUODENUM_FLUID' | 'ASPIRATE' | 'BONE_AND_JOINT' | 'CATHETER_EXIT_SITE' | 'EYE' | 'GASTRIC_FLUID' | 'GENITAL_SWAB' | 'LOWER_RESPIRATORY_TRACT' | 'PUS' | 'SEMEN' | 'SKIN' | 'SOFT_TISSUE' | 'WOUND' | 'ABSCESS_SWAB' | 'BONE' | 'BONE_MARROW' | 'CONJUNCTIVAL_SWAB' | 'MIDDLE_EAR_FLUID' | 'PLASMA' | 'SWAB_UNSPECIFIED' | 'TEARS' | 'CORD_BLOOD' | 'LUNG_TISSUE' | 'PLACENTA' | 'ULCER_SWAB' | 'UNKNOWN' | 'OTHER' required
sampleMaterialTextstring
samplePurpose'EXTERNAL' | 'INTERNAL' required
sampleSource'HUMAN' | 'ANIMAL' | 'ENVIRONMENT'
samplingReason'PRESENCE_OF_SYMPTOMS' | 'OUTBREAK' | 'SCREENING' | 'PROFESSIONAL_REASON' | 'QUARANTINE_REGULATIONS' | 'CONTACT_TO_CASE' | 'PLANNING_TO_TRAVEL' | 'RETURNING_TRAVELER' | 'PERSONAL_REASON' | 'MOVING_RETURNING_RETIREMENT_HOME' | 'SWISS_COVID_APP_NOTIFICATION' | 'QUARANTINE_END' | 'UNKNOWN' | 'OTHER_REASON'
samplingReasonDetailsstring
shipmentDatestring date-time
shipmentDetailsstring
shippedboolean
specimenCondition'ADEQUATE' | 'NOT_ADEQUATE'
uuidstring

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

  • 7e7a28e948a5Revision changes
    • info

      added the new ELEK_TEST enum value to the request property //

  • e66bf835c941Revision changes
    • info

      added the new NON_AMPLIFIED_NUCLEIC_ACID_PROBE_TEST enum value to the request property //

    • info

      added the new PENICILLINASE_ACTIVITY enum value to the request property //