Skip to navigation

/diseases/outbreaks/regions

View as Markdown

Returns subdivisions (states, provinces, or equivalent) for outbreak geography, scoped to one reporting country.

countryId is required (use the same GIDEON code as country on GET /diseases/outbreaks/filter). sourceCountryId is accepted as a legacy synonym. If neither is set, data is an empty array.

Each row has region_code (numeric subdivision id for the reporting country) and region (display name). Pass region_code as the region query parameter on GET /diseases/outbreaks/filter. Those ids align with region_id under data.regions on GET /diseases/outbreaks/filter-options when country is set.

Query parameters

NameRequiredDescription
countryIdYes (for data)GIDEON country code.
sourceCountryIdNoSame as countryId; supported for backward compatibility.
searchNoIf set, only rows whose region name starts with this string are returned (prefix match).

Authentication

Authorizationstring
API Key authentication via header

Query parameters

countryIdstringOptional

GIDEON country code for the reporting country (required for a non-empty list).

Response

OK
datalist of objects