> For the complete documentation index, see [llms.txt](https://docs.humdata.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.humdata.org/build/hdx-apis/hapi/api-reference/models.md).
# Models
## The Admin1Response object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"Admin1Response":{"properties":{"id":{"type":"integer","title":"Id","description":"1st subnational administrative division, using the unique identifier (id) from the admin1 table associated with each entry."},"location_ref":{"type":"integer","title":"Location Ref","description":"A location (typically a country) reference number."},"code":{"type":"string","maxLength":128,"title":"Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["id","location_ref","code","name","from_cods","reference_period_start","reference_period_end","location_code","location_name"],"title":"Admin1Response"}}}}
```
## The Admin2Response object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"Admin2Response":{"properties":{"id":{"type":"integer","title":"Id","description":"2nd subnational administrative division, using the unique identifier (id) from the admin2 table associated with each entry."},"admin1_ref":{"type":"integer","title":"Admin1 Ref","description":"The 2nd subnational administrative division reference number."},"code":{"type":"string","maxLength":128,"title":"Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"admin1_code":{"type":"string","maxLength":128,"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"type":"string","maxLength":512,"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"location_ref":{"type":"integer","title":"Location Ref","description":"A location (typically a country) reference number."}},"type":"object","required":["id","admin1_ref","code","name","from_cods","reference_period_start","reference_period_end","admin1_code","admin1_name","location_code","location_name","location_ref"],"title":"Admin2Response"}}}}
```
## The AdminLevel object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"AdminLevel":{"type":"string","enum":["0","1","2"],"title":"AdminLevel"}}}}
```
## The AggregationPeriod object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"AggregationPeriod":{"type":"string","enum":["dekad","1-month","3-month"],"title":"AggregationPeriod"}}}}
```
## The AvailabilityResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"AvailabilityResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"category":{"type":"string","maxLength":32,"title":"Category","description":"HAPI category"},"subcategory":{"type":"string","maxLength":512,"title":"Subcategory","description":"HAPI subcategory"},"hapi_updated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Hapi Updated Date","description":"Date that dataset was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","category","subcategory","hapi_updated_date"],"title":"AvailabilityResponse"}}}}
```
## The BadRequestResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"}}}}
```
## The CommodityCategory object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"CommodityCategory":{"type":"string","enum":["cereals and tubers","meat, fish and eggs","milk and dairy","miscellaneous food","non-food","oil and fats","pulses and nuts","vegetables and fruits"],"title":"CommodityCategory"}}}}
```
## The ConflictEventResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"ConflictEventResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"event_type":{"$ref":"#/components/schemas/EventType","description":"Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described here."},"events":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Events","description":"The number of events with the given `event_type`"},"fatalities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fatalities","description":"The number of fatalities due to the given `event_type`"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","event_type","events","fatalities","reference_period_start","reference_period_end"],"title":"ConflictEventResponse"},"EventType":{"type":"string","enum":["civilian_targeting","demonstration","political_violence"],"title":"EventType"}}}}
```
## The CurrencyResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"CurrencyResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"ISO-4217 currency code"},"name":{"type":"string","maxLength":512,"title":"Name","description":"Currency name"}},"type":"object","required":["code","name"],"title":"CurrencyResponse"}}}}
```
## The DTMAssessmentType object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"DTMAssessmentType":{"type":"string","enum":["BA","ETT","SA"],"title":"DTMAssessmentType"}}}}
```
## The DatasetResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"DatasetResponse":{"properties":{"dataset_hdx_id":{"type":"string","maxLength":36,"title":"Dataset Hdx Id","description":"The dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX."},"dataset_hdx_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Stub","description":"The URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX."},"dataset_hdx_title":{"type":"string","maxLength":1024,"title":"Dataset Hdx Title","description":"The title of the dataset as it appears in the HDX interface. This name is not unique and can change."},"hdx_provider_stub":{"type":"string","maxLength":128,"title":"Hdx Provider Stub","description":"The URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[hdx_provider_stub]` will load the provider's page on HDX."},"hdx_provider_name":{"type":"string","maxLength":512,"title":"Hdx Provider Name","description":"The display name of the provider (organization) of the dataset on HDX."},"hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Link","readOnly":true},"hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Api Link","readOnly":true},"provider_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Link","readOnly":true},"provider_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Api Link","readOnly":true}},"type":"object","required":["dataset_hdx_id","dataset_hdx_stub","dataset_hdx_title","hdx_provider_stub","hdx_provider_name","hdx_link","hdx_api_link","provider_hdx_link","provider_hdx_api_link"],"title":"DatasetResponse"}}}}
```
## The EventType object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"EventType":{"type":"string","enum":["civilian_targeting","demonstration","political_violence"],"title":"EventType"}}}}
```
## The FoodPriceResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"FoodPriceResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Unique resource UUID on HDX"},"market_code":{"type":"string","maxLength":32,"title":"Market Code","description":"The unique code identifying the market"},"market_name":{"type":"string","maxLength":512,"title":"Market Name","description":"The name of the market"},"commodity_code":{"type":"string","maxLength":32,"title":"Commodity Code","description":"The unique code identifying the commodity"},"commodity_name":{"type":"string","maxLength":512,"title":"Commodity Name","description":"The name of the commodity"},"commodity_category":{"$ref":"#/components/schemas/CommodityCategory","description":"The food group that the commodity belongs to, available values are described here."},"currency_code":{"type":"string","maxLength":32,"title":"Currency Code","description":"ISO-4217 currency code"},"unit":{"type":"string","maxLength":32,"title":"Unit","description":"The unit of the commodity, such as weight or number"},"price_flag":{"$ref":"#/components/schemas/PriceFlag","description":"The pre-processing characteristics of food prices, available values are described here."},"price_type":{"$ref":"#/components/schemas/PriceType","description":"The point in the supply chain at which the price is determined, available values are described here."},"price":{"type":"number","minimum":0,"title":"Price"},"lat":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"title":"Lat","description":"The market's latitude"},"lon":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"title":"Lon","description":"The market's longitude"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","market_code","market_name","commodity_code","commodity_name","commodity_category","currency_code","unit","price_flag","price_type","price","lat","lon","reference_period_start","reference_period_end"],"title":"FoodPriceResponse"},"CommodityCategory":{"type":"string","enum":["cereals and tubers","meat, fish and eggs","milk and dairy","miscellaneous food","non-food","oil and fats","pulses and nuts","vegetables and fruits"],"title":"CommodityCategory"},"PriceFlag":{"type":"string","enum":["actual","aggregate","actual,aggregate"],"title":"PriceFlag"},"PriceType":{"type":"string","enum":["Farm Gate","Producer","Retail","Wholesale"],"title":"PriceType"}}}}
```
## The FoodSecurityResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"FoodSecurityResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Filter the response by the resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"ipc_phase":{"type":"string","maxLength":32,"title":"Ipc Phase","description":"The IPC phase, available values are described here."},"ipc_type":{"type":"string","maxLength":32,"title":"Ipc Type","description":"The IPC type, available values are described here."},"population_in_phase":{"type":"integer","title":"Population In Phase","description":"The number of people in the IPC phase"},"population_fraction_in_phase":{"type":"number","title":"Population Fraction In Phase","description":"The fraction of people in the IPC phase"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","ipc_phase","ipc_type","population_in_phase","population_fraction_in_phase","reference_period_start","reference_period_end"],"title":"FoodSecurityResponse"}}}}
```
## The FundingResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"FundingResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Filter the response by the resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"appeal_code":{"type":"string","maxLength":64,"title":"Appeal Code","description":"A unique code given by FTS to each appeal"},"appeal_name":{"type":"string","maxLength":256,"title":"Appeal Name","description":"Name of the appeal"},"appeal_type":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Appeal Type","description":"The type of the appeal, such as flash or HRP"},"requirements_usd":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Requirements Usd","description":"The funding requirements in US dollars"},"funding_usd":{"type":"number","minimum":0,"title":"Funding Usd","description":"The actual funding in US dollars"},"funding_pct":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Funding Pct","description":"The percentage of required funding received by the appeal"},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["resource_hdx_id","appeal_code","appeal_name","appeal_type","requirements_usd","funding_usd","funding_pct","location_code","location_name","reference_period_start","reference_period_end"],"title":"FundingResponse"}}}}
```
## The Gender object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The HTTPValidationError object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```
## The HapiGenericResponse\_Admin1Response\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_Admin1Response_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Admin1Response"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[Admin1Response]"},"Admin1Response":{"properties":{"id":{"type":"integer","title":"Id","description":"1st subnational administrative division, using the unique identifier (id) from the admin1 table associated with each entry."},"location_ref":{"type":"integer","title":"Location Ref","description":"A location (typically a country) reference number."},"code":{"type":"string","maxLength":128,"title":"Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["id","location_ref","code","name","from_cods","reference_period_start","reference_period_end","location_code","location_name"],"title":"Admin1Response"}}}}
```
## The HapiGenericResponse\_Admin2Response\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_Admin2Response_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Admin2Response"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[Admin2Response]"},"Admin2Response":{"properties":{"id":{"type":"integer","title":"Id","description":"2nd subnational administrative division, using the unique identifier (id) from the admin2 table associated with each entry."},"admin1_ref":{"type":"integer","title":"Admin1 Ref","description":"The 2nd subnational administrative division reference number."},"code":{"type":"string","maxLength":128,"title":"Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"admin1_code":{"type":"string","maxLength":128,"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"type":"string","maxLength":512,"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"location_ref":{"type":"integer","title":"Location Ref","description":"A location (typically a country) reference number."}},"type":"object","required":["id","admin1_ref","code","name","from_cods","reference_period_start","reference_period_end","admin1_code","admin1_name","location_code","location_name","location_ref"],"title":"Admin2Response"}}}}
```
## The HapiGenericResponse\_AvailabilityResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_AvailabilityResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/AvailabilityResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[AvailabilityResponse]"},"AvailabilityResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"category":{"type":"string","maxLength":32,"title":"Category","description":"HAPI category"},"subcategory":{"type":"string","maxLength":512,"title":"Subcategory","description":"HAPI subcategory"},"hapi_updated_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Hapi Updated Date","description":"Date that dataset was last updated, e.g. 2020-01-01 or 2020-01-01T00:00:00"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","category","subcategory","hapi_updated_date"],"title":"AvailabilityResponse"}}}}
```
## The HapiGenericResponse\_ConflictEventResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_ConflictEventResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ConflictEventResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[ConflictEventResponse]"},"ConflictEventResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"event_type":{"$ref":"#/components/schemas/EventType","description":"Filter the response by the ACLED event-type categories (non-mutually exclusive), available values are described here."},"events":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Events","description":"The number of events with the given `event_type`"},"fatalities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fatalities","description":"The number of fatalities due to the given `event_type`"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","event_type","events","fatalities","reference_period_start","reference_period_end"],"title":"ConflictEventResponse"},"EventType":{"type":"string","enum":["civilian_targeting","demonstration","political_violence"],"title":"EventType"}}}}
```
## The HapiGenericResponse\_CurrencyResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_CurrencyResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CurrencyResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[CurrencyResponse]"},"CurrencyResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"ISO-4217 currency code"},"name":{"type":"string","maxLength":512,"title":"Name","description":"Currency name"}},"type":"object","required":["code","name"],"title":"CurrencyResponse"}}}}
```
## The HapiGenericResponse\_DatasetResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_DatasetResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DatasetResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[DatasetResponse]"},"DatasetResponse":{"properties":{"dataset_hdx_id":{"type":"string","maxLength":36,"title":"Dataset Hdx Id","description":"The dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX."},"dataset_hdx_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Stub","description":"The URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX."},"dataset_hdx_title":{"type":"string","maxLength":1024,"title":"Dataset Hdx Title","description":"The title of the dataset as it appears in the HDX interface. This name is not unique and can change."},"hdx_provider_stub":{"type":"string","maxLength":128,"title":"Hdx Provider Stub","description":"The URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[hdx_provider_stub]` will load the provider's page on HDX."},"hdx_provider_name":{"type":"string","maxLength":512,"title":"Hdx Provider Name","description":"The display name of the provider (organization) of the dataset on HDX."},"hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Link","readOnly":true},"hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Api Link","readOnly":true},"provider_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Link","readOnly":true},"provider_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Api Link","readOnly":true}},"type":"object","required":["dataset_hdx_id","dataset_hdx_stub","dataset_hdx_title","hdx_provider_stub","hdx_provider_name","hdx_link","hdx_api_link","provider_hdx_link","provider_hdx_api_link"],"title":"DatasetResponse"}}}}
```
## The HapiGenericResponse\_FoodPriceResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_FoodPriceResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FoodPriceResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[FoodPriceResponse]"},"FoodPriceResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Unique resource UUID on HDX"},"market_code":{"type":"string","maxLength":32,"title":"Market Code","description":"The unique code identifying the market"},"market_name":{"type":"string","maxLength":512,"title":"Market Name","description":"The name of the market"},"commodity_code":{"type":"string","maxLength":32,"title":"Commodity Code","description":"The unique code identifying the commodity"},"commodity_name":{"type":"string","maxLength":512,"title":"Commodity Name","description":"The name of the commodity"},"commodity_category":{"$ref":"#/components/schemas/CommodityCategory","description":"The food group that the commodity belongs to, available values are described here."},"currency_code":{"type":"string","maxLength":32,"title":"Currency Code","description":"ISO-4217 currency code"},"unit":{"type":"string","maxLength":32,"title":"Unit","description":"The unit of the commodity, such as weight or number"},"price_flag":{"$ref":"#/components/schemas/PriceFlag","description":"The pre-processing characteristics of food prices, available values are described here."},"price_type":{"$ref":"#/components/schemas/PriceType","description":"The point in the supply chain at which the price is determined, available values are described here."},"price":{"type":"number","minimum":0,"title":"Price"},"lat":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"title":"Lat","description":"The market's latitude"},"lon":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"title":"Lon","description":"The market's longitude"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","market_code","market_name","commodity_code","commodity_name","commodity_category","currency_code","unit","price_flag","price_type","price","lat","lon","reference_period_start","reference_period_end"],"title":"FoodPriceResponse"},"CommodityCategory":{"type":"string","enum":["cereals and tubers","meat, fish and eggs","milk and dairy","miscellaneous food","non-food","oil and fats","pulses and nuts","vegetables and fruits"],"title":"CommodityCategory"},"PriceFlag":{"type":"string","enum":["actual","aggregate","actual,aggregate"],"title":"PriceFlag"},"PriceType":{"type":"string","enum":["Farm Gate","Producer","Retail","Wholesale"],"title":"PriceType"}}}}
```
## The HapiGenericResponse\_FoodSecurityResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_FoodSecurityResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FoodSecurityResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[FoodSecurityResponse]"},"FoodSecurityResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Filter the response by the resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"ipc_phase":{"type":"string","maxLength":32,"title":"Ipc Phase","description":"The IPC phase, available values are described here."},"ipc_type":{"type":"string","maxLength":32,"title":"Ipc Type","description":"The IPC type, available values are described here."},"population_in_phase":{"type":"integer","title":"Population In Phase","description":"The number of people in the IPC phase"},"population_fraction_in_phase":{"type":"number","title":"Population Fraction In Phase","description":"The fraction of people in the IPC phase"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","ipc_phase","ipc_type","population_in_phase","population_fraction_in_phase","reference_period_start","reference_period_end"],"title":"FoodSecurityResponse"}}}}
```
## The HapiGenericResponse\_FundingResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_FundingResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FundingResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[FundingResponse]"},"FundingResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"Filter the response by the resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"appeal_code":{"type":"string","maxLength":64,"title":"Appeal Code","description":"A unique code given by FTS to each appeal"},"appeal_name":{"type":"string","maxLength":256,"title":"Appeal Name","description":"Name of the appeal"},"appeal_type":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Appeal Type","description":"The type of the appeal, such as flash or HRP"},"requirements_usd":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Requirements Usd","description":"The funding requirements in US dollars"},"funding_usd":{"type":"number","minimum":0,"title":"Funding Usd","description":"The actual funding in US dollars"},"funding_pct":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Funding Pct","description":"The percentage of required funding received by the appeal"},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["resource_hdx_id","appeal_code","appeal_name","appeal_type","requirements_usd","funding_usd","funding_pct","location_code","location_name","reference_period_start","reference_period_end"],"title":"FundingResponse"}}}}
```
## The HapiGenericResponse\_HumanitarianNeedsResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_HumanitarianNeedsResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/HumanitarianNeedsResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[HumanitarianNeedsResponse]"},"HumanitarianNeedsResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"sector_code":{"type":"string","maxLength":32,"title":"Sector Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"category":{"type":"string","maxLength":128,"title":"Category","description":"A category combining gender, age range, disability marker and population group information"},"population_status":{"$ref":"#/components/schemas/PopulationStatus","description":"The population status, available values are described here."},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"sector_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Sector Name","description":"The name of the sector"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","sector_code","category","population_status","population","reference_period_start","reference_period_end","sector_name"],"title":"HumanitarianNeedsResponse"},"PopulationStatus":{"type":"string","enum":["AFF","INN","TGT","REA","all"],"title":"PopulationStatus"}}}}
```
## The HapiGenericResponse\_IdpsResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_IdpsResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/IdpsResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[IdpsResponse]"},"IdpsResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"reporting_round":{"type":"integer","title":"Reporting Round","description":"Data collection round number"},"assessment_type":{"$ref":"#/components/schemas/DTMAssessmentType","description":"Either baseline assessment (BA),site assessment (SA) or event track (ETT)"},"operation":{"type":"string","title":"Operation","description":"Name of DTM Operation for which the data was collected"},"population":{"type":"integer","title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","reporting_round","assessment_type","operation","population","reference_period_start","reference_period_end"],"title":"IdpsResponse"},"DTMAssessmentType":{"type":"string","enum":["BA","ETT","SA"],"title":"DTMAssessmentType"}}}}
```
## The HapiGenericResponse\_LocationResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_LocationResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/LocationResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[LocationResponse]"},"LocationResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"A location (typically a country), using the unique identifier (id) from the location table associated with each entry."},"code":{"type":"string","maxLength":128,"title":"Code","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"name":{"type":"string","maxLength":512,"title":"Name","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"has_hrp":{"type":"boolean","title":"Has Hrp","description":"The has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan."},"in_gho":{"type":"boolean","title":"In Gho","description":"The in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["id","code","name","has_hrp","in_gho","from_cods","reference_period_start","reference_period_end"],"title":"LocationResponse"}}}}
```
## The HapiGenericResponse\_NationalRiskResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_NationalRiskResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/NationalRiskResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[NationalRiskResponse]"},"NationalRiskResponse":{"properties":{"risk_class":{"$ref":"#/components/schemas/RiskClass","description":"The INFORM risk class, available values are described here."},"global_rank":{"type":"integer","maximum":250,"minimum":1,"title":"Global Rank","description":"The rank of the country based on `overall_risk`. Higher rank (smaller number) is associated with more risk."},"overall_risk":{"type":"number","maximum":10,"minimum":0,"title":"Overall Risk","description":"The INFORM composite risk index, based on a combination of 54 indicators into three dimensions of risk: hazard and exposure, vulnerability, and lack of coping capacity. Risk score is given out of 10."},"hazard_exposure_risk":{"type":"number","maximum":10,"minimum":0,"title":"Hazard Exposure Risk","description":"Risk due to events that may occur, and exposure to them. Risk score is given out of 10. "},"vulnerability_risk":{"type":"number","maximum":10,"minimum":0,"title":"Vulnerability Risk","description":"Risk due to hazard susceptibility. Risk score is given out of 10."},"coping_capacity_risk":{"type":"number","maximum":10,"minimum":0,"title":"Coping Capacity Risk","description":"Risk due to lack of coping capacity to alleviate hazard impact. Risk score is given out of 10."},"meta_missing_indicators_pct":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"title":"Meta Missing Indicators Pct","description":"The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy"},"meta_avg_recentness_years":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Meta Avg Recentness Years","description":"The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy)"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["risk_class","global_rank","overall_risk","hazard_exposure_risk","vulnerability_risk","coping_capacity_risk","meta_missing_indicators_pct","meta_avg_recentness_years","reference_period_start","reference_period_end","resource_hdx_id","location_code","location_name"],"title":"NationalRiskResponse"},"RiskClass":{"type":"string","enum":["1","2","3","4","5"],"title":"RiskClass"}}}}
```
## The HapiGenericResponse\_OperationalPresenceResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_OperationalPresenceResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OperationalPresenceResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[OperationalPresenceResponse]"},"OperationalPresenceResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"org_acronym":{"type":"string","maxLength":32,"title":"Org Acronym","description":"The organization acronym"},"org_name":{"type":"string","maxLength":512,"title":"Org Name","description":"The organization name"},"sector_code":{"type":"string","maxLength":32,"title":"Sector Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"sector_name":{"type":"string","maxLength":512,"title":"Sector Name","description":"The name of the sector"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"org_type_code":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Code","description":"The code referring to the organization type"},"org_type_description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Org Type Description","description":"A description of the organization type"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","org_acronym","org_name","sector_code","sector_name","reference_period_start","reference_period_end","org_type_code","org_type_description"],"title":"OperationalPresenceResponse"}}}}
```
## The HapiGenericResponse\_OrgResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_OrgResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[OrgResponse]"},"OrgResponse":{"properties":{"acronym":{"type":"string","maxLength":32,"title":"Acronym","description":"The organization acronym"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The organization name"},"org_type_code":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Code","description":"The code referring to the organization type"},"org_type_description":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Description","description":"A description of the organization type"}},"type":"object","required":["acronym","name","org_type_code","org_type_description"],"title":"OrgResponse"}}}}
```
## The HapiGenericResponse\_OrgTypeResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_OrgTypeResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OrgTypeResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[OrgTypeResponse]"},"OrgTypeResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":" The code referring to the organization type, derived either from the [OCHA Digital Services organization types list](https://data.humdata.org/dataset/organization-types-beta), or created for HDX HAPI"},"description":{"type":"string","maxLength":512,"title":"Description","description":"A description of the organization type"}},"type":"object","required":["code","description"],"title":"OrgTypeResponse"}}}}
```
## The HapiGenericResponse\_PopulationResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_PopulationResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PopulationResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[PopulationResponse]"},"PopulationResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","title":"Population","description":"The number of people"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end"],"title":"PopulationResponse"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The HapiGenericResponse\_PovertyRateResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_PovertyRateResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PovertyRateResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[PovertyRateResponse]"},"PovertyRateResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"mpi":{"type":"number","title":"Mpi","description":"The multidimensional poverty index, derived as a product of the `headcount_ratio` and `intensity_of_deprivation`. Note that this metric is presented as a fraction, while the others are percentages."},"headcount_ratio":{"type":"number","title":"Headcount Ratio","description":"The percentage of people deprived in 33% or more indicators"},"intensity_of_deprivation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Intensity Of Deprivation","description":"The average proportion of indicators in which people are deprived, given as a percentage."},"vulnerable_to_poverty":{"type":"number","title":"Vulnerable To Poverty","description":"The percentage of people deprived in 20-33% of indicators"},"in_severe_poverty":{"type":"number","title":"In Severe Poverty","description":"The percentage of people deprived in 50% or more indicators"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin_level","resource_hdx_id","mpi","headcount_ratio","intensity_of_deprivation","vulnerable_to_poverty","in_severe_poverty","reference_period_start","reference_period_end"],"title":"PovertyRateResponse"}}}}
```
## The HapiGenericResponse\_RainfallResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_RainfallResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RainfallResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[RainfallResponse]"},"RainfallResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"aggregation_period":{"$ref":"#/components/schemas/AggregationPeriod","description":"The aggregation period, available values are described here."},"provider_admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Admin1 Code","description":"The 1st subnational administrative divisions provided in the original data source."},"provider_admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Admin2 Code","description":"The 2nd subnational administrative divisions provided in the original data source."},"rainfall":{"type":"number","minimum":0,"title":"Rainfall"},"rainfall_long_term_average":{"type":"number","minimum":0,"title":"Rainfall Long Term Average"},"rainfall_anomaly_pct":{"type":"number","minimum":0,"title":"Rainfall Anomaly Pct"},"number_pixels":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Pixels","description":"Rainfall number pixels"},"version":{"anyOf":[{"$ref":"#/components/schemas/Version"},{"type":"null"}],"description":"Version rainfall"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","aggregation_period","provider_admin1_code","provider_admin2_code","rainfall","rainfall_long_term_average","rainfall_anomaly_pct","number_pixels","version","reference_period_start","reference_period_end"],"title":"RainfallResponse"},"AggregationPeriod":{"type":"string","enum":["dekad","1-month","3-month"],"title":"AggregationPeriod"},"Version":{"type":"string","enum":["final","forecast","preliminary"],"title":"Version"}}}}
```
## The HapiGenericResponse\_RefugeesResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_RefugeesResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/RefugeesResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[RefugeesResponse]"},"RefugeesResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"population_group":{"$ref":"#/components/schemas/PopulationGroup","description":"The population group, available values are described here."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"origin_location_code":{"type":"string","maxLength":128,"title":"Origin Location Code","description":"Location of origin p-code (ISO-3)"},"origin_location_name":{"type":"string","maxLength":512,"title":"Origin Location Name","description":"Location of origin name"},"asylum_location_code":{"type":"string","maxLength":128,"title":"Asylum Location Code","description":"Location of asylum p-code (ISO-3)"},"asylum_location_name":{"type":"string","maxLength":512,"title":"Asylum Location Name","description":"Location of asylum name"}},"type":"object","required":["resource_hdx_id","population_group","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end","origin_location_code","origin_location_name","asylum_location_code","asylum_location_name"],"title":"RefugeesResponse"},"PopulationGroup":{"type":"string","enum":["REF","ROC","ASY","OIP","IDP","IOC","STA","OOC","HST","RET","RST","NAT","RDP","RRI","all"],"title":"PopulationGroup"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The HapiGenericResponse\_ResourceResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_ResourceResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ResourceResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[ResourceResponse]"},"ResourceResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"dataset_hdx_id":{"type":"string","maxLength":36,"title":"Dataset Hdx Id","description":"The dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX."},"name":{"type":"string","maxLength":256,"title":"Name","description":"The resource name on HDX. In combination with the dataset UUIDsfrom the `dataset_hdx_id` and `resource_hdx_id` fields respectively, it can be used to construct a URL to download the resource: `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]/download/[name]`, which can be found in the `download_url` field."},"format":{"type":"string","maxLength":32,"title":"Format","description":"The format of the resource on HDX. These are typically file formats (i.e. CSV, XLSX), but can also include APIs and web apps."},"update_date":{"type":"string","format":"date-time","title":"Update Date","description":"The date the resource was last updated"},"is_hxl":{"type":"boolean","title":"Is Hxl","description":"whether or not the resource contains HXL tags."},"download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Download Url","description":"A URL to directly download the resource file from HDX, in the format specified in the `format` field."},"hapi_updated_date":{"type":"string","format":"date-time","title":"Hapi Updated Date","description":"The date that the resource was ingested into HDX HAPI"},"dataset_hdx_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Stub","description":"The URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX."},"dataset_hdx_title":{"type":"string","maxLength":1024,"title":"Dataset Hdx Title","description":"The title of the dataset as it appears in the HDX interface. This name is not unique and can change."},"dataset_hdx_provider_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Provider Stub","description":"Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[dataset_hdx_provider_stub]` will load the provider's page on HDX."},"dataset_hdx_provider_name":{"type":"string","maxLength":512,"title":"Dataset Hdx Provider Name","description":"Filter the response by the display name of the provider (organization) of the dataset on HDX."},"hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Link","readOnly":true},"hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Api Link","readOnly":true},"dataset_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Dataset Hdx Link","readOnly":true},"dataset_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Dataset Hdx Api Link","readOnly":true},"provider_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Link","readOnly":true},"provider_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Api Link","readOnly":true}},"type":"object","required":["resource_hdx_id","dataset_hdx_id","name","format","update_date","is_hxl","download_url","hapi_updated_date","dataset_hdx_stub","dataset_hdx_title","dataset_hdx_provider_stub","dataset_hdx_provider_name","hdx_link","hdx_api_link","dataset_hdx_link","dataset_hdx_api_link","provider_hdx_link","provider_hdx_api_link"],"title":"ResourceResponse"}}}}
```
## The HapiGenericResponse\_ReturneesResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_ReturneesResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReturneesResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[ReturneesResponse]"},"ReturneesResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"population_group":{"$ref":"#/components/schemas/PopulationGroup","description":"The population group, available values are described here."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"origin_location_code":{"type":"string","maxLength":128,"title":"Origin Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"origin_location_name":{"type":"string","maxLength":512,"title":"Origin Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"asylum_location_code":{"type":"string","maxLength":128,"title":"Asylum Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"asylum_location_name":{"type":"string","maxLength":512,"title":"Asylum Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["resource_hdx_id","population_group","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end","origin_location_code","origin_location_name","asylum_location_code","asylum_location_name"],"title":"ReturneesResponse"},"PopulationGroup":{"type":"string","enum":["REF","ROC","ASY","OIP","IDP","IOC","STA","OOC","HST","RET","RST","NAT","RDP","RRI","all"],"title":"PopulationGroup"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The HapiGenericResponse\_SectorResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_SectorResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SectorResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[SectorResponse]"},"SectorResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the sector"}},"type":"object","required":["code","name"],"title":"SectorResponse"}}}}
```
## The HapiGenericResponse\_WfpCommodityResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_WfpCommodityResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WfpCommodityResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[WfpCommodityResponse]"},"WfpCommodityResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"The unique code identifying the commodity"},"category":{"$ref":"#/components/schemas/CommodityCategory","description":"The food group that the commodity belongs to, available values are described here."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the commodity"}},"type":"object","required":["code","category","name"],"title":"WfpCommodityResponse"},"CommodityCategory":{"type":"string","enum":["cereals and tubers","meat, fish and eggs","milk and dairy","miscellaneous food","non-food","oil and fats","pulses and nuts","vegetables and fruits"],"title":"CommodityCategory"}}}}
```
## The HapiGenericResponse\_WfpMarketResponse\_ object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HapiGenericResponse_WfpMarketResponse_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WfpMarketResponse"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"HapiGenericResponse[WfpMarketResponse]"},"WfpMarketResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"code":{"type":"string","maxLength":32,"title":"Code","description":"The unique code identifying the market"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the market"},"lat":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"title":"Lat","description":"The market's latitude"},"lon":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"title":"Lon","description":"The market's longitude"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","code","name","lat","lon"],"title":"WfpMarketResponse"}}}}
```
## The HumanitarianNeedsResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"HumanitarianNeedsResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"sector_code":{"type":"string","maxLength":32,"title":"Sector Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"category":{"type":"string","maxLength":128,"title":"Category","description":"A category combining gender, age range, disability marker and population group information"},"population_status":{"$ref":"#/components/schemas/PopulationStatus","description":"The population status, available values are described here."},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"sector_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Sector Name","description":"The name of the sector"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","sector_code","category","population_status","population","reference_period_start","reference_period_end","sector_name"],"title":"HumanitarianNeedsResponse"},"PopulationStatus":{"type":"string","enum":["AFF","INN","TGT","REA","all"],"title":"PopulationStatus"}}}}
```
## The IPCPhase object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"IPCPhase":{"type":"string","enum":["1","2","3","4","5","3+","all"],"title":"IPCPhase"}}}}
```
## The IPCType object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"IPCType":{"type":"string","enum":["current","first projection","second projection"],"title":"IPCType"}}}}
```
## The IdentifierResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"IdentifierResponse":{"properties":{"encoded_app_identifier":{"type":"string","maxLength":512,"title":"Encoded App Identifier","description":"Base64 encoded app_identifier compiled from application name and email address"}},"type":"object","required":["encoded_app_identifier"],"title":"IdentifierResponse"}}}}
```
## The IdpsResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"IdpsResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"reporting_round":{"type":"integer","title":"Reporting Round","description":"Data collection round number"},"assessment_type":{"$ref":"#/components/schemas/DTMAssessmentType","description":"Either baseline assessment (BA),site assessment (SA) or event track (ETT)"},"operation":{"type":"string","title":"Operation","description":"Name of DTM Operation for which the data was collected"},"population":{"type":"integer","title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","reporting_round","assessment_type","operation","population","reference_period_start","reference_period_end"],"title":"IdpsResponse"},"DTMAssessmentType":{"type":"string","enum":["BA","ETT","SA"],"title":"DTMAssessmentType"}}}}
```
## The LocationResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"LocationResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"A location (typically a country), using the unique identifier (id) from the location table associated with each entry."},"code":{"type":"string","maxLength":128,"title":"Code","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"name":{"type":"string","maxLength":512,"title":"Name","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"has_hrp":{"type":"boolean","title":"Has Hrp","description":"The has_hrp flag. The has_hrp flag indicates whether a country has a Humanitarian Response Plan."},"in_gho":{"type":"boolean","title":"In Gho","description":"The in_gho flag. The in_gho flag indicates whether a country is in the Global Humanitarian Overview."},"from_cods":{"type":"boolean","title":"From Cods"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["id","code","name","has_hrp","in_gho","from_cods","reference_period_start","reference_period_end"],"title":"LocationResponse"}}}}
```
## The NationalRiskResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"NationalRiskResponse":{"properties":{"risk_class":{"$ref":"#/components/schemas/RiskClass","description":"The INFORM risk class, available values are described here."},"global_rank":{"type":"integer","maximum":250,"minimum":1,"title":"Global Rank","description":"The rank of the country based on `overall_risk`. Higher rank (smaller number) is associated with more risk."},"overall_risk":{"type":"number","maximum":10,"minimum":0,"title":"Overall Risk","description":"The INFORM composite risk index, based on a combination of 54 indicators into three dimensions of risk: hazard and exposure, vulnerability, and lack of coping capacity. Risk score is given out of 10."},"hazard_exposure_risk":{"type":"number","maximum":10,"minimum":0,"title":"Hazard Exposure Risk","description":"Risk due to events that may occur, and exposure to them. Risk score is given out of 10. "},"vulnerability_risk":{"type":"number","maximum":10,"minimum":0,"title":"Vulnerability Risk","description":"Risk due to hazard susceptibility. Risk score is given out of 10."},"coping_capacity_risk":{"type":"number","maximum":10,"minimum":0,"title":"Coping Capacity Risk","description":"Risk due to lack of coping capacity to alleviate hazard impact. Risk score is given out of 10."},"meta_missing_indicators_pct":{"anyOf":[{"type":"number","maximum":100,"minimum":0},{"type":"null"}],"title":"Meta Missing Indicators Pct","description":"The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy"},"meta_avg_recentness_years":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"title":"Meta Avg Recentness Years","description":"The average of the total number of years older than the reference year per indicator, to account for any older data used as a proxy)"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["risk_class","global_rank","overall_risk","hazard_exposure_risk","vulnerability_risk","coping_capacity_risk","meta_missing_indicators_pct","meta_avg_recentness_years","reference_period_start","reference_period_end","resource_hdx_id","location_code","location_name"],"title":"NationalRiskResponse"},"RiskClass":{"type":"string","enum":["1","2","3","4","5"],"title":"RiskClass"}}}}
```
## The OperationalPresenceResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"OperationalPresenceResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"org_acronym":{"type":"string","maxLength":32,"title":"Org Acronym","description":"The organization acronym"},"org_name":{"type":"string","maxLength":512,"title":"Org Name","description":"The organization name"},"sector_code":{"type":"string","maxLength":32,"title":"Sector Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"sector_name":{"type":"string","maxLength":512,"title":"Sector Name","description":"The name of the sector"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"org_type_code":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Code","description":"The code referring to the organization type"},"org_type_description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Org Type Description","description":"A description of the organization type"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","org_acronym","org_name","sector_code","sector_name","reference_period_start","reference_period_end","org_type_code","org_type_description"],"title":"OperationalPresenceResponse"}}}}
```
## The OrgResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"OrgResponse":{"properties":{"acronym":{"type":"string","maxLength":32,"title":"Acronym","description":"The organization acronym"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The organization name"},"org_type_code":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Code","description":"The code referring to the organization type"},"org_type_description":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Org Type Description","description":"A description of the organization type"}},"type":"object","required":["acronym","name","org_type_code","org_type_description"],"title":"OrgResponse"}}}}
```
## The OrgTypeResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"OrgTypeResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":" The code referring to the organization type, derived either from the [OCHA Digital Services organization types list](https://data.humdata.org/dataset/organization-types-beta), or created for HDX HAPI"},"description":{"type":"string","maxLength":512,"title":"Description","description":"A description of the organization type"}},"type":"object","required":["code","description"],"title":"OrgTypeResponse"}}}}
```
## The OutputFormat object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"OutputFormat":{"type":"string","enum":["csv","json"],"title":"OutputFormat"}}}}
```
## The PopulationGroup object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PopulationGroup":{"type":"string","enum":["REF","ROC","ASY","OIP","IDP","IOC","STA","OOC","HST","RET","RST","NAT","RDP","RRI","all"],"title":"PopulationGroup"}}}}
```
## The PopulationResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PopulationResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","title":"Population","description":"The number of people"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end"],"title":"PopulationResponse"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The PopulationStatus object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PopulationStatus":{"type":"string","enum":["AFF","INN","TGT","REA","all"],"title":"PopulationStatus"}}}}
```
## The PovertyRateResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PovertyRateResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"mpi":{"type":"number","title":"Mpi","description":"The multidimensional poverty index, derived as a product of the `headcount_ratio` and `intensity_of_deprivation`. Note that this metric is presented as a fraction, while the others are percentages."},"headcount_ratio":{"type":"number","title":"Headcount Ratio","description":"The percentage of people deprived in 33% or more indicators"},"intensity_of_deprivation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Intensity Of Deprivation","description":"The average proportion of indicators in which people are deprived, given as a percentage."},"vulnerable_to_poverty":{"type":"number","title":"Vulnerable To Poverty","description":"The percentage of people deprived in 20-33% of indicators"},"in_severe_poverty":{"type":"number","title":"In Severe Poverty","description":"The percentage of people deprived in 50% or more indicators"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin_level","resource_hdx_id","mpi","headcount_ratio","intensity_of_deprivation","vulnerable_to_poverty","in_severe_poverty","reference_period_start","reference_period_end"],"title":"PovertyRateResponse"}}}}
```
## The PriceFlag object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PriceFlag":{"type":"string","enum":["actual","aggregate","actual,aggregate"],"title":"PriceFlag"}}}}
```
## The PriceType object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"PriceType":{"type":"string","enum":["Farm Gate","Producer","Retail","Wholesale"],"title":"PriceType"}}}}
```
## The RainfallResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"RainfallResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"aggregation_period":{"$ref":"#/components/schemas/AggregationPeriod","description":"The aggregation period, available values are described here."},"provider_admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Admin1 Code","description":"The 1st subnational administrative divisions provided in the original data source."},"provider_admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Provider Admin2 Code","description":"The 2nd subnational administrative divisions provided in the original data source."},"rainfall":{"type":"number","minimum":0,"title":"Rainfall"},"rainfall_long_term_average":{"type":"number","minimum":0,"title":"Rainfall Long Term Average"},"rainfall_anomaly_pct":{"type":"number","minimum":0,"title":"Rainfall Anomaly Pct"},"number_pixels":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Pixels","description":"Rainfall number pixels"},"version":{"anyOf":[{"$ref":"#/components/schemas/Version"},{"type":"null"}],"description":"Version rainfall"},"reference_period_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","resource_hdx_id","aggregation_period","provider_admin1_code","provider_admin2_code","rainfall","rainfall_long_term_average","rainfall_anomaly_pct","number_pixels","version","reference_period_start","reference_period_end"],"title":"RainfallResponse"},"AggregationPeriod":{"type":"string","enum":["dekad","1-month","3-month"],"title":"AggregationPeriod"},"Version":{"type":"string","enum":["final","forecast","preliminary"],"title":"Version"}}}}
```
## The RefugeesResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"RefugeesResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"population_group":{"$ref":"#/components/schemas/PopulationGroup","description":"The population group, available values are described here."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"origin_location_code":{"type":"string","maxLength":128,"title":"Origin Location Code","description":"Location of origin p-code (ISO-3)"},"origin_location_name":{"type":"string","maxLength":512,"title":"Origin Location Name","description":"Location of origin name"},"asylum_location_code":{"type":"string","maxLength":128,"title":"Asylum Location Code","description":"Location of asylum p-code (ISO-3)"},"asylum_location_name":{"type":"string","maxLength":512,"title":"Asylum Location Name","description":"Location of asylum name"}},"type":"object","required":["resource_hdx_id","population_group","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end","origin_location_code","origin_location_name","asylum_location_code","asylum_location_name"],"title":"RefugeesResponse"},"PopulationGroup":{"type":"string","enum":["REF","ROC","ASY","OIP","IDP","IOC","STA","OOC","HST","RET","RST","NAT","RDP","RRI","all"],"title":"PopulationGroup"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The ResourceResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"ResourceResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"dataset_hdx_id":{"type":"string","maxLength":36,"title":"Dataset Hdx Id","description":"The dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]` will load the dataset page on HDX."},"name":{"type":"string","maxLength":256,"title":"Name","description":"The resource name on HDX. In combination with the dataset UUIDsfrom the `dataset_hdx_id` and `resource_hdx_id` fields respectively, it can be used to construct a URL to download the resource: `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]/download/[name]`, which can be found in the `download_url` field."},"format":{"type":"string","maxLength":32,"title":"Format","description":"The format of the resource on HDX. These are typically file formats (i.e. CSV, XLSX), but can also include APIs and web apps."},"update_date":{"type":"string","format":"date-time","title":"Update Date","description":"The date the resource was last updated"},"is_hxl":{"type":"boolean","title":"Is Hxl","description":"whether or not the resource contains HXL tags."},"download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Download Url","description":"A URL to directly download the resource file from HDX, in the format specified in the `format` field."},"hapi_updated_date":{"type":"string","format":"date-time","title":"Hapi Updated Date","description":"The date that the resource was ingested into HDX HAPI"},"dataset_hdx_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Stub","description":"The URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_stub]` will load the dataset page on HDX."},"dataset_hdx_title":{"type":"string","maxLength":1024,"title":"Dataset Hdx Title","description":"The title of the dataset as it appears in the HDX interface. This name is not unique and can change."},"dataset_hdx_provider_stub":{"type":"string","maxLength":128,"title":"Dataset Hdx Provider Stub","description":"Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of `https://data.humdata.org/organization/[dataset_hdx_provider_stub]` will load the provider's page on HDX."},"dataset_hdx_provider_name":{"type":"string","maxLength":512,"title":"Dataset Hdx Provider Name","description":"Filter the response by the display name of the provider (organization) of the dataset on HDX."},"hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Link","readOnly":true},"hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Hdx Api Link","readOnly":true},"dataset_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Dataset Hdx Link","readOnly":true},"dataset_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Dataset Hdx Api Link","readOnly":true},"provider_hdx_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Link","readOnly":true},"provider_hdx_api_link":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Provider Hdx Api Link","readOnly":true}},"type":"object","required":["resource_hdx_id","dataset_hdx_id","name","format","update_date","is_hxl","download_url","hapi_updated_date","dataset_hdx_stub","dataset_hdx_title","dataset_hdx_provider_stub","dataset_hdx_provider_name","hdx_link","hdx_api_link","dataset_hdx_link","dataset_hdx_api_link","provider_hdx_link","provider_hdx_api_link"],"title":"ResourceResponse"}}}}
```
## The ResponseValidationResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"ResponseValidationResponse":{"properties":{"error_sample_list":{"items":{},"type":"array","title":"Error Sample List"},"error":{"type":"string","title":"Error"}},"type":"object","required":["error_sample_list","error"],"title":"ResponseValidationResponse"}}}}
```
## The ReturneesResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"ReturneesResponse":{"properties":{"resource_hdx_id":{"type":"string","maxLength":36,"title":"Resource Hdx Id","description":"The resource ID, which is a unique and fixed identifier of a resource on HDX. A URL in the pattern of `https://data.humdata.org/dataset/[dataset_hdx_id]/resource/[resource_hdx_id]` will load the resource page on HDX."},"population_group":{"$ref":"#/components/schemas/PopulationGroup","description":"The population group, available values are described here."},"gender":{"$ref":"#/components/schemas/Gender","description":"The gender, available values are described here."},"age_range":{"type":"string","maxLength":32,"title":"Age Range","description":"The age range. These are expressed as [start age]-[end age], or [start age]+ for an age range starting at [start age] or above. The end age is assumed to be inclusive, though that is not always explicit in the source data."},"min_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Min Age","description":"The minimum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation"},"max_age":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Max Age","description":"The maximum age from `age_range`, set to `null` if `age_range` is \"all\" and there is no age disaggregation, or if there is no upper limit to the age range"},"population":{"type":"integer","minimum":0,"title":"Population","description":"The number of people"},"reference_period_start":{"type":"string","format":"date-time","title":"Reference Period Start","description":"The start date for which the data are applicable"},"reference_period_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Reference Period End","description":"The end date for which the data are applicable"},"origin_location_code":{"type":"string","maxLength":128,"title":"Origin Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"origin_location_name":{"type":"string","maxLength":512,"title":"Origin Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"asylum_location_code":{"type":"string","maxLength":128,"title":"Asylum Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"asylum_location_name":{"type":"string","maxLength":512,"title":"Asylum Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."}},"type":"object","required":["resource_hdx_id","population_group","gender","age_range","min_age","max_age","population","reference_period_start","reference_period_end","origin_location_code","origin_location_name","asylum_location_code","asylum_location_name"],"title":"ReturneesResponse"},"PopulationGroup":{"type":"string","enum":["REF","ROC","ASY","OIP","IDP","IOC","STA","OOC","HST","RET","RST","NAT","RDP","RRI","all"],"title":"PopulationGroup"},"Gender":{"type":"string","enum":["f","m","x","u","o","all"],"title":"Gender"}}}}
```
## The RiskClass object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"RiskClass":{"type":"string","enum":["1","2","3","4","5"],"title":"RiskClass"}}}}
```
## The SectorResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"SectorResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"The sector code, derived either from the [Global Coordination Groups](https://data.humdata.org/dataset/global-coordination-groups-beta?) dataset, or created for HDX HAPI"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the sector"}},"type":"object","required":["code","name"],"title":"SectorResponse"}}}}
```
## The ValidationError object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```
## The Version object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"Version":{"type":"string","enum":["final","forecast","preliminary"],"title":"Version"}}}}
```
## The VersionResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"VersionResponse":{"properties":{"api_version":{"type":"string","maxLength":16,"title":"Api Version"},"hapi_sqlalchemy_schema_version":{"type":"string","maxLength":16,"title":"Hapi Sqlalchemy Schema Version"}},"type":"object","required":["api_version","hapi_sqlalchemy_schema_version"],"title":"VersionResponse"}}}}
```
## The WfpCommodityResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"WfpCommodityResponse":{"properties":{"code":{"type":"string","maxLength":32,"title":"Code","description":"The unique code identifying the commodity"},"category":{"$ref":"#/components/schemas/CommodityCategory","description":"The food group that the commodity belongs to, available values are described here."},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the commodity"}},"type":"object","required":["code","category","name"],"title":"WfpCommodityResponse"},"CommodityCategory":{"type":"string","enum":["cereals and tubers","meat, fish and eggs","milk and dairy","miscellaneous food","non-food","oil and fats","pulses and nuts","vegetables and fruits"],"title":"CommodityCategory"}}}}
```
## The WfpMarketResponse object
```json
{"openapi":"3.1.0","info":{"title":"HDX HAPI","version":"0.9.13"},"components":{"schemas":{"WfpMarketResponse":{"properties":{"location_code":{"type":"string","maxLength":128,"title":"Location Code","description":"A location (typically a country). The location codes use the ISO-3 (ISO 3166 alpha-3) codes."},"location_name":{"type":"string","maxLength":512,"title":"Location Name","description":"A location (typically a country). The location names are based on the \"short name\" from the UN M49 Standard."},"admin1_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin1 Code","description":"The 1st subnational administrative divisions. The admin1 codes refer to the p-codes in the Common Operational Datasets."},"admin1_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin1 Name","description":"The 1st subnational administrative divisions. The admin1 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin2_code":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Admin2 Code","description":"The 2nd subnational administrative divisions. The admin2 codes refer to the p-codes in the Common Operational Datasets."},"admin2_name":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Admin2 Name","description":"The 2nd subnational administrative divisions. The admin2 names refer to either the Common Operational Datasets or those provided in the original data source."},"admin_level":{"type":"integer","title":"Admin Level","description":"Admin level."},"code":{"type":"string","maxLength":32,"title":"Code","description":"The unique code identifying the market"},"name":{"type":"string","maxLength":512,"title":"Name","description":"The name of the market"},"lat":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"title":"Lat","description":"The market's latitude"},"lon":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"title":"Lon","description":"The market's longitude"}},"type":"object","required":["location_code","location_name","admin1_code","admin1_name","admin2_code","admin2_name","admin_level","code","name","lat","lon"],"title":"WfpMarketResponse"}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.humdata.org/build/hdx-apis/hapi/api-reference/models.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.