Contact 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/contacts/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/contacts/push
  • Auth
    none declared

Request body

additionalDetailsstring
careForPeopleOver60'YES' | 'NO' | 'UNKNOWN'
caseIdExternalSystemstring
caseOrEventInformationstring
caseReferenceNumberstring
changeDatestring date-time
contactCategory'HIGH_RISK' | 'HIGH_RISK_MED' | 'MEDIUM_RISK_MED' | 'LOW_RISK' | 'NO_RISK'
contactClassification'UNCONFIRMED' | 'CONFIRMED' | 'NO_CONTACT'
contactIdentificationSource'CASE_PERSON' | 'CONTACT_PERSON' | 'TRACING_APP' | 'OTHER' | 'UNKNOWN'
contactIdentificationSourceDetailsstring
contactProximitiesstring[]
contactProximityDetailsstring
contactStatus'ACTIVE' | 'CONVERTED' | 'DROPPED'
creationDatestring date-time
deletedboolean
deletionReason'GDPR' | 'DELETION_REQUEST' | 'CREATED_WITH_NO_LEGAL_REASON' | 'TRANSFERRED_RESPONSIBILITY' | 'DUPLICATE_ENTRIES' | 'OTHER_REASON'
descriptionstring
disease'AFP' | 'CHOLERA' | 'CONGENITAL_RUBELLA' | 'CSM' | 'DENGUE' | 'EVD' | 'GUINEA_WORM' | 'LASSA' | 'MEASLES' | 'MONKEYPOX' | 'NEW_INFLUENZA' | 'PLAGUE' | 'POLIO' | 'UNSPECIFIED_VHF' | 'WEST_NILE_FEVER' | 'YELLOW_FEVER' | 'RABIES' | 'ANTHRAX' | 'CORONAVIRUS' | 'PNEUMONIA' | 'MALARIA' | 'TYPHOID_FEVER' | 'ACUTE_VIRAL_HEPATITIS' | 'NON_NEONATAL_TETANUS' | 'HIV' | 'SCHISTOSOMIASIS' | 'SOIL_TRANSMITTED_HELMINTHS' | 'TRYPANOSOMIASIS' | 'DIARRHEA_DEHYDRATION' | 'DIARRHEA_BLOOD' | 'SNAKE_BITE' | 'RUBELLA' | 'TUBERCULOSIS' | 'LATENT_TUBERCULOSIS' | 'LEPROSY' | 'LYMPHATIC_FILARIASIS' | 'BURULI_ULCER' | 'PERTUSSIS' | 'NEONATAL_TETANUS' | 'ONCHOCERCIASIS' | 'DIPHTHERIA' | 'TRACHOMA' | 'YAWS_ENDEMIC_SYPHILIS' | 'MATERNAL_DEATHS' | 'PERINATAL_DEATHS' | 'INFLUENZA' | 'INFLUENZA_A' | 'INFLUENZA_B' | 'H_METAPNEUMOVIRUS' | 'RESPIRATORY_SYNCYTIAL_VIRUS' | 'PARAINFLUENZA_1_4' | 'ADENOVIRUS' | 'RHINOVIRUS' | 'ENTEROVIRUS' | 'M_PNEUMONIAE' | 'C_PNEUMONIAE' | 'ARI' | 'CHIKUNGUNYA' | 'POST_IMMUNIZATION_ADVERSE_EVENTS_MILD' | 'POST_IMMUNIZATION_ADVERSE_EVENTS_SEVERE' | 'FHA' | 'INVASIVE_PNEUMOCOCCAL_INFECTION' | 'INVASIVE_MENINGOCOCCAL_INFECTION' | 'GIARDIASIS' | 'CRYPTOSPORIDIOSIS' | 'SHIGELLOSIS' | 'SALMONELLOSIS' | 'SYPHILIS' | 'YERSINIOSIS' | 'MUMPS' | 'GONOCOCCAL_INFECTION' | 'OTHER' | 'UNDEFINED' required
diseaseDetailsstring
endOfQuarantineReason'ASYMPTOMATIC' | 'ISOLATED_AS_CASE' | 'LOST_TO_FOLLOWUP' | 'OTHER'
endOfQuarantineReasonDetailsstring
externalIDstring
externalTokenstring
firstContactDatestring date-time
followUpCommentstring
followUpStatus'FOLLOW_UP' | 'COMPLETED' | 'CANCELED' | 'LOST' | 'NO_FOLLOW_UP'
followUpStatusChangeDatestring date-time
followUpUntilstring date-time
highPriorityboolean
immuneGlobulinProposedboolean
immunosuppressiveTherapyBasicDisease'YES' | 'NO' | 'UNKNOWN'
immunosuppressiveTherapyBasicDiseaseDetailsstring
inJurisdictionboolean
informationReliability'TRUSTED' | 'UNRELIABLE' | 'UNKNOWN'
internalTokenstring
lastContactDatestring date-time
multiDayContactboolean
numberOfDosesinteger
otherDeletionReasonstring
overwriteFollowUpUntilboolean
ownershipHandedOverboolean
postpartum'YES' | 'NO' | 'UNKNOWN'
pregnant'YES' | 'NO' | 'UNKNOWN'
prescribedDrug'AMIKACIN' | 'BEDAQUILINE' | 'CAPREOMYCIN' | 'CIPROFLOXACIN' | 'DELAMANID' | 'ETHAMBUTOL' | 'GATIFLOXACIN' | 'ISONIAZID' | 'KANAMYCIN' | 'LEVOFLOXACIN' | 'MOXIFLOXACIN' | 'OFLOXACIN' | 'RIFAMPICIN' | 'STREPTOMYCIN' | 'CEFTRIAXONE' | 'PENICILLIN' | 'ERYTHROMYCIN' | 'AZITHROMYCIN' | 'CEFIXIME' | 'TETRACYCLINE' | 'GENTAMICIN' | 'SPECTINOMYCIN' | 'CEFTAZIDIME' | 'CEFOTAXIME' | 'AMPICILLIN' | 'TRIMETHOPRIM_SULFAMETHOXAZOLE' | 'CLINDAMYCIN' | 'LINEZOLID' | 'MEROPENEM' | 'OTHER'
prescribedDrugTextstring
previousQuarantineTostring date-time
prohibitionToWork'YES' | 'NO' | 'UNKNOWN'
prohibitionToWorkFromstring date-time
prohibitionToWorkUntilstring date-time
prophylaxisPrescribedboolean
pseudonymizedboolean
quarantine'HOME' | 'INSTITUTIONELL' | 'HOSPITAL' | 'HOTEL' | 'ASYLUM_ACCOMMODATION' | 'NONE' | 'UNKNOWN' | 'OTHER'
quarantineChangeCommentstring
quarantineExtendedboolean
quarantineFromstring date-time
quarantineHelpNeededstring
quarantineHomePossible'YES' | 'NO' | 'UNKNOWN'
quarantineHomePossibleCommentstring
quarantineHomeSupplyEnsured'YES' | 'NO' | 'UNKNOWN'
quarantineHomeSupplyEnsuredCommentstring
quarantineOfficialOrderSentboolean
quarantineOfficialOrderSentDatestring date-time
quarantineOrderedOfficialDocumentboolean
quarantineOrderedOfficialDocumentDatestring date-time
quarantineOrderedVerballyboolean
quarantineOrderedVerballyDatestring date-time
quarantineReducedboolean
quarantineTostring date-time
quarantineTypeDetailsstring
relationDescriptionstring
relationToCase'SAME_HOUSEHOLD' | 'FAMILY_MEMBER_OR_FRIEND' | 'SAME_ENVIRONMENT' | 'MEDICAL_CARE' | 'OTHER'
reportDateTimestring date-time required
reportLatnumber double
reportLatLonAccuracynumber float
reportLonnumber double
returningTraveler'YES' | 'NO' | 'UNKNOWN'
tracingApp'CORONA_WARN_APP' | 'OTHER' | 'UNKNOWN'
tracingAppDetailsstring
trimester'FIRST' | 'SECOND' | 'THIRD' | 'UNKNOWN'
uuidstring
vaccinationDoseOneDatestring date-time
vaccinationDoseTwoDatestring date-time
vaccinationProposedboolean
vaccinationStatus'VACCINATED' | 'UNVACCINATED' | 'RECOVERED' | 'HAD_THE_DISEASE' | 'OTHER' | 'UNKNOWN'
vaccinationStatusDetailsstring
vaccinationStatusLastUpdatedstring date-time

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
    • breaking

      removed the enum value ANIMAL of the request property //

    • breaking

      removed the enum value BAKERY_PRODUCTS of the request property //

    • breaking

      removed the enum value BATS_CONTACT of the request property //

    • breaking

      removed the enum value BOVINE_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value BROILER_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value BUFFET_MEALS of the request property //

    • breaking

      removed the enum value CANNED_FOOD_PRODUCTS of the request property //

    • breaking

      removed the enum value CATS_CONTACT of the request property //

    • breaking

      removed the enum value CEREAL_PRODUCTS of the request property //

    • breaking

      removed the enum value CHEESE of the request property //

    • breaking

      removed the enum value DOGS_CONTACT of the request property //

    • breaking

      removed the enum value DRINKS_BOTTLED_WATER of the request property //

    • breaking

      removed the enum value EGG_PRODUCTS of the request property //

    • breaking

      removed the enum value EXOTIC_PET_CONTACT of the request property //

    • breaking

      removed the enum value FARM_ANIMAL_CONTACT of the request property //

    • breaking

      removed the enum value FISH_PRODUCTS of the request property //

    • breaking

      removed the enum value FOOD of the request property //

    • breaking

      removed the enum value FOX_CONTACT of the request property //

    • breaking

      removed the enum value FRUITS_AND_JUICES of the request property //

    • breaking

      removed the enum value GAME_MEAT_NOT_WILD_BOAR of the request property //

    • breaking

      removed the enum value HERBS_AND_SPICES of the request property //

    • breaking

      removed the enum value JUICE_AND_VEGETABLE_PRODUCTS of the request property //

    • breaking

      removed the enum value MILK of the request property //

    • breaking

      removed the enum value MIXED_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value NON_CHEESES_DAIRY_PRODUCTS of the request property //

    • breaking

      removed the enum value NOT_APPLICABLE of the request property //

    • breaking

      removed the enum value OTHER of the request property //

    • breaking

      removed the enum value OTHER_FOODS of the request property //

    • breaking

      removed the enum value OTHER_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value OTHER_PET_CONTACT of the request property //

    • breaking

      removed the enum value OTHER_WILD_ANIMAL_CONTACT of the request property //

    • breaking

      removed the enum value PORK_PRODUCTS of the request property //

    • breaking

      removed the enum value SHEEP_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value SHELLFISH_PRODUCTS of the request property //

    • breaking

      removed the enum value Sprouts of the request property //

    • breaking

      removed the enum value TAP_AND_WELL_WATER of the request property //

    • breaking

      removed the enum value TURKEY_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value UNKNOWN of the request property //

    • breaking

      removed the enum value UNSPECIFIED_POULTRY of the request property //

    • breaking

      removed the enum value WILD_BOAR_MEAT_PRODUCTS of the request property //

    • breaking

      removed the enum value confectionery of the request property //

    • breaking

      the // request property type changed from string to array

    • info

      added the new CLINDAMYCIN enum value to the request property /

    • info

      added the new LINEZOLID enum value to the request property /

    • info

      added the new MEROPENEM enum value to the request property /

  • a4ef960fde19Revision changes
    • breaking

      removed the enum value DIPHTERIA of the request property /

    • info

      added the new DIPHTHERIA enum value to the request property /