Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-17162044.6 KB
Case

Upserts a case

Creates or updates a case, depending on whether the provided values for the caseReference.sourceId and caseReference.sourceEntryId fields correspond to an existing case record.

put/cases

Request body

SGTF'NA' | '0' | '1'

Example request

{
  "location": {
    "country": "GB"
  },
  "travelHistory": {
    "travel": [
      {
        "location": {
          "country": "CR",
          "administrativeAreaLevel1": "Any province in Costa Rica",
          "administrativeAreaLevel2": "Any canton in Costa Rica",
          "administrativeAreaLevel3": "Any district in Costa Rica",
          "place": "Boston Children's Hospital",
          "name": "Lyon, Auvergne-Rhône-Alpes, France"
        }
      }
    ]
  },
  "vaccines": [
    {
      "name": "AstraZeneca",
      "batch": "PV12345"
    }
  ]
}

Response

OK

SGTF'NA' | '0' | '1'

Example response

{
  "location": {
    "country": "GB"
  },
  "travelHistory": {
    "travel": [
      {
        "location": {
          "country": "CR",
          "administrativeAreaLevel1": "Any province in Costa Rica",
          "administrativeAreaLevel2": "Any canton in Costa Rica",
          "administrativeAreaLevel3": "Any district in Costa Rica",
          "place": "Boston Children's Hospital",
          "name": "Lyon, Auvergne-Rhône-Alpes, France"
        }
      }
    ]
  },
  "vaccines": [
    {
      "name": "AstraZeneca",
      "batch": "PV12345"
    }
  ]
}