Person 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/persons/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/persons/push
  • Auth
    none declared

Request body

additionalDetailsstring
approximateAgeinteger
approximateAgeReferenceDatestring date-time
approximateAgeType'YEARS' | 'MONTHS' | 'DAYS'
armedForcesRelationType'UNKNOWN' | 'NO_RELATION' | 'CIVIL' | 'SOLDIER_OR_RELATIVE'
birthNamestring
birthWeightinteger
birthWeightCategory'NORMAL' | 'LOW_BIRTH_WEIGHT'
birthdateDDinteger
birthdateMMinteger
birthdateYYYYinteger
burialConductor'FAMILY_COMMUNITY' | 'OUTBREAK_TEAM'
burialDatestring date-time
burialPlaceDescriptionstring
causeOfDeath'EPIDEMIC_DISEASE' | 'OTHER_CAUSE'
causeOfDeathDetailsstring
causeOfDeathDisease'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'
changeDatestring date-time
covidCodeDeliveredboolean
creationDatestring date-time
deathDatestring date-time
deathPlaceDescriptionstring
deathPlaceType'COMMUNITY' | 'HOSPITAL' | 'OTHER'
educationDetailsstring
educationType'NONE' | 'NURSERY' | 'PRIMARY' | 'SECONDARY' | 'TERTIARY' | 'OTHER'
emailAddressstring
emancipatedboolean
entryDatestring date-time
externalIdstring
externalTokenstring
fathersNamestring
firstNamestring required
gestationAgeAtBirthinteger
gestationalAgeCategory'AT_TERM' | 'PREMATURE_BEFORE_32' | 'PREMATURE_32_TO_38'
hasCovidAppboolean
inJurisdictionboolean
incapacitatedboolean
internalTokenstring
lastNamestring required
livingStatus'MIGRANT' | 'FOREIGNER' | 'HOMELESS' | 'REGISTERED_AT_A_RESIDENCE'
mothersMaidenNamestring
mothersNamestring
multipleBirth'SINGLE' | 'TWINS' | 'MULTIPLE'
namesOfGuardiansstring
nationalHealthIdstring
nicknamestring
occupationDetailsstring
otherSalutationstring
passportNumberstring
phonestring
placeOfBirthFacilityDetailsstring
placeOfBirthFacilityType'ASSOCIATION' | 'BUSINESS' | 'BAR' | 'CAMPSITE' | 'CANTINE' | 'CHILDRENS_DAY_CARE' | 'CHILDRENS_HOME' | 'CORRECTIONAL_FACILITY' | 'CRUISE_SHIP' | 'ELDERLY_DAY_CARE' | 'EVENT_VENUE' | 'FOOD_STALL' | 'HOLIDAY_CAMP' | 'HOMELESS_SHELTER' | 'HOSPITAL' | 'HOSTEL' | 'HOTEL' | 'KINDERGARTEN' | 'LABORATORY' | 'MASS_ACCOMMODATION' | 'MILITARY_BARRACKS' | 'MOBILE_NURSING_SERVICE' | 'NIGHT_CLUB' | 'OTHER_ACCOMMODATION' | 'OTHER_CARE_FACILITY' | 'OTHER_CATERING_OUTLET' | 'OTHER_EDUCATIONAL_FACILITY' | 'OTHER_LEISURE_FACILITY' | 'OTHER_MEDICAL_FACILITY' | 'OTHER_RESIDENCE' | 'OTHER_WORKING_PLACE' | 'OTHER_COMMERCE' | 'OUTPATIENT_TREATMENT_FACILITY' | 'PLACE_OF_WORSHIP' | 'PUBLIC_PLACE' | 'REFUGEE_ACCOMMODATION' | 'REHAB_FACILITY' | 'RESTAURANT' | 'RETIREMENT_HOME' | 'RETAIL' | 'WHOLESALE' | 'SCHOOL' | 'SWIMMING_POOL' | 'THEATER' | 'UNIVERSITY' | 'ZOO' | 'AMBULATORY_SURGERY_FACILITY' | 'DIALYSIS_FACILITY' | 'DAY_HOSPITAL' | 'MATERNITY_FACILITY' | 'MEDICAL_PRACTICE' | 'DENTAL_PRACTICE' | 'OTHER_MEDICAL_PRACTICE' | 'DIAGNOSTIC_PREVENTATIVE_THERAPEUTIC_FACILITY' | 'EMERGENCY_MEDICAL_SERVICES' | 'ELDERLY_CARE_FACILITY' | 'DISABLED_PERSON_HABITATION' | 'CARE_RECIPIENT_HABITATION' | 'VISITING_AMBULATORY_AID' | 'AFTER_SCHOOL'
presentCondition'ALIVE' | 'DEAD' | 'BURIED' | 'UNKNOWN'
pseudonymizedboolean
salutation'MR' | 'MRS' | 'MR_AND_MRS' | 'FAMILY' | 'GUARDIAN_OF_MINOR' | 'OTHER'
sex'MALE' | 'FEMALE' | 'OTHER' | 'UNKNOWN' required
symptomJournalStatus'UNREGISTERED' | 'REGISTERED' | 'ACCEPTED' | 'REJECTED' | 'DELETED'
uuidstring
workPlace'SCHOOL' | 'NURSERY' | 'UNKNOWN' | 'OTHER'
workPlaceTextstring

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

  • a4ef960fde19Revision changes
    • breaking

      removed the enum value DIPHTERIA of the request property /

    • info

      added the new DIPHTHERIA enum value to the request property /

  • de78e37bb222Revision changes
    • info

      added the new GONOCOCCAL_INFECTION enum value to the request property /