GLglobaldothealth
Case

Lists cases

Changed on
get/cases

Request

  • Base URL
    http://localhost:3000/api
  • URL
    http://localhost:3000/api/cases
  • Auth
    none declared

Query parameters

pageinteger

The pages of cases to skip before starting to collect the result set

limitinteger

The number of items to return

count_limitinteger

The maximum number of documents that will be counted in mongoDB to make queries faster

sort_bystring

Keyword to sort by

orderstring

Sorting order

qstring

The search query

Response

OK

Example response

{
  "cases": [
    {
      "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"
        }
      ]
    }
  ]
}

Changes

  • 886deae8a6f9Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • e11f54229b64Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status