Geographic

Country

Through this endpoint you can obtain a list with all the countries registered in the system. This endpoint is used through the Http GET method.

To make use of this endpoint you must follow the following steps:

The endpoint must follow the following format https://webapi.aclimate.org/api/Geographic/Country/{format}

Examples:

Country Parameters

Parameter

Description

Type

id

Corresponds to the Id of the country.

ObjectId

iso2

Corresponds to the international ISO code that is assigned to each country. A list of ISO 2 codes for each country is available at http://www.nationsonline.org/oneworld/country_code_list.htm.

String

name

Corresponds to the name of the country.

String

JSON format example:

country_example_1 json view

CSV format example:

country_example_2 csv view

Geographic

Through this endpoint you can obtain a list of the states of the selected country with each of their municipalities and weather stations and for each weather station their ranges for each crop. This endpoint is used through the Http GET method.

To make use of this endpoint you must follow the following steps:

  • This endpoint is made up of the base_URL + /api + /Geographic/ (https://webapi.aclimate.org/api/Geographic/)

  • This endpoint needs two parameters:

    • countryId: Represents the id of the country from which you want to obtain the information.

    • format: to learn more about format parameter click here format.

The endpoint must follow the following format https://webapi.aclimate.org/api/Geographic/{countryId}/{format}

Examples:

State parameters

Parameter

Description

Type

id

Corresponds to the Id of state.

ObjectId

name

Corresponds to the name of state.

String

country

To learn more click here Country Parameters.

Country

municipalities

To learn more click here Municipalities parameters.

Array of municipalities

Municipalities parameters

Parameter

Description

Type

id

Corresponds to the Id of the municipality.

ObjectId

name

Corresponds to the name of the municipality.

String

weather_stations

To learn more click here Weather stations parameters.

Arrays of weather stations

Weather stations parameters

Parameter

Description

Type

id

Unique identifier

ObjectId

name

This parameter corresponds to the name of the weather station.

String

ext_id

This parameter corresponds to the Id of the data source (external id)

String

ranges

To learn more click here Weather station ranges.

Array of ranges

origin

This parameter corresponds to the name of entity owns this weather station.

String

latitude

This parameter corresponds to the decimal latitude of the location of the weather station.

Double

longitude

This parameter corresponds to the decimal longitude of the location of the weather station.

Double

Weather station ranges

Parameter

Description

Type

crop_id

Corresponds to the id of the crop to which the range belongs.

ObjectId

crop_name

Corresponds to the name of the crop to which the range belongs.

String

label

Range name.

String

lower

Minimum limit

Double

upper

Maximum limit.

Double

JSON format example:

country_id_example_1 json view

CSV format example:

country_id_example_2 csv view

Crop

Through this end point you can obtain a list of the states of the selected country with each of their municipalities and meteorological stations and for each meteorological station their productive ranges for each crop.

The states are grouped by crops, this endpoint lists all the states for the crops that the selected country has. This endpoint is used through the Http GET method.

To make use of this endpoint you must follow the following steps:

  • This endpoint is made up of the base_URL + /api + /Geographic/Crop/ (https://webapi.aclimate.org/api/Geographic/Crop/)

  • This endpoint needs two parameters:

    • countryId: Represents the id of the country from which you want to obtain the information.

    • format: to learn more about format parameter click here format.

The endpoint must follow the following format https://webapi.aclimate.org/api/Geographic/Crop/{countryId}/{format}

Examples:

Crop

Parameter

Description

Type

id

Corresponds to the id of the crop.

ObjectId

name

Corresponds to the name of the crop.

String

states

To learn more click here State parameters.

Array of states

JSON format example:

country_crop_example_1 json view

CSV format example:

country_crop_example_2 csv view