Taxonomy

This section has operations to build up the taxonomy of choice, i.e. categories, indicators, and units, as well as United Nation's Sustainability Development Goals and EU Environmental Objectives.

Returns all United Nations Sustainable Development Goals

POST https://api.bws.ninja/v1/call

Use this operation to explore which UN SDGs that are available to reference in your taxonomy.

Request Body

[
    {
        "sdg_id": 1,
        "goal_no": "1",
        "sdg": "No poverty",
        "language": "English"
    },
    {
        "sdg_id": 2,
        "goal_no": "2",
        "sdg": "Zero hunger",
        "language": "English"
    },
    {
        "sdg_id": 3,
        "goal_no": "3",
        "sdg": "Good health and well-being",
        "language": "English"
    },
    {
        "sdg_id": 4,
        "goal_no": "4",
        "sdg": "Quality education",
        "language": "English"
    },
    {
        "sdg_id": 5,
        "goal_no": "5",
        "sdg": "Gender equality",
        "language": "English"
    },
    {
        "sdg_id": 6,
        "goal_no": "6",
        "sdg": "Clean water and sanitation",
        "language": "English"
    },
    {
        "sdg_id": 7,
        "goal_no": "7",
        "sdg": "Affordable and clean energy",
        "language": "English"
    },
    {
        "sdg_id": 8,
        "goal_no": "8",
        "sdg": "Decent work and economic growth",
        "language": "English"
    },
    {
        "sdg_id": 9,
        "goal_no": "9",
        "sdg": "Industry, innovation and infrastructure",
        "language": "English"
    },
    {
        "sdg_id": 10,
        "goal_no": "10",
        "sdg": "Reduced inequality",
        "language": "English"
    },
    {
        "sdg_id": 11,
        "goal_no": "11",
        "sdg": "Sustainable cities and communities",
        "language": "English"
    },
    {
        "sdg_id": 12,
        "goal_no": "12",
        "sdg": "Responsible consumption and production",
        "language": "English"
    },
    {
        "sdg_id": 13,
        "goal_no": "13",
        "sdg": "Climate action",
        "language": "English"
    },
    {
        "sdg_id": 14,
        "goal_no": "14",
        "sdg": "Life below water",
        "language": "English"
    },
    {
        "sdg_id": 15,
        "goal_no": "15",
        "sdg": "Life on land",
        "language": "English"
    },
    {
        "sdg_id": 16,
        "goal_no": "16",
        "sdg": "Peace and strong justice institutions",
        "language": "English"
    },
    {
        "sdg_id": 17,
        "goal_no": "17",
        "sdg": "Partnerships to achieve the goal",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getSDGs",
     "parameters": {
        "language_code": "en"
        }
    }

Returns European Union Environmental Development Objectives

POST https://api.bws.ninja/v1/call

Use this operation to explore which EU Objectives that are available to reference in your taxonomy.

Request Body

[
    {
        "eu_objectiv_id": 1,
        "objective_no": "1",
        "objective": "Climate change mitigation",
        "language": "English"
    },
    {
        "eu_objectiv_id": 2,
        "objective_no": "2",
        "objective": "Climate change adaptation",
        "language": "English"
    },
    {
        "eu_objectiv_id": 3,
        "objective_no": "3",
        "objective": "Sustainable use and protection of water and marine resources",
        "language": "English"
    },
    {
        "eu_objectiv_id": 4,
        "objective_no": "4",
        "objective": "Transition to a circular economy",
        "language": "English"
    },
    {
        "eu_objectiv_id": 5,
        "objective_no": "5",
        "objective": "Pollution prevention and control",
        "language": "English"
    },
    {
        "eu_objectiv_id": 6,
        "objective_no": "6",
        "objective": "Protection and restoration of biodiversity and ecosystems",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getEUObjectives",
    "parameters": {
        "language_code": "en"
        }
    }

Returns the categories of the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to retrieve all categories of your taxonomy.

Request Body

[
    {
        "category_id": 63,
        "category_name": "Renewable energy",
        "language": "English"
    },
    {
        "category_id": 64,
        "category_name": "Green buildings",
        "language": "English"
    },
    {
        "category_id": 65,
        "category_name": "Sustainable forestry",
        "language": "English"
    },
    {
        "category_id": 66,
        "category_name": "Clean transportation",
        "language": "English"
    },
    {
        "category_id": 67,
        "category_name": "Energy efficiency",
        "language": "English"
    },
    {
        "category_id": 68,
        "category_name": "Pollution prevention and control",
        "language": "English"
    },
    {
        "category_id": 69,
        "category_name": "Circular economy",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getCategories",
    "parameters": {
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Returns the sub categories of the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to retrieve all sub categories of your taxonomy.

Request Body

[
    {
        "sub_category_id": 55,
        "sub_category_name": "Wind power",
        "category_id": 63,
        "category_name": "Renewable energy",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 56,
        "sub_category_name": "Hydro- and solar power, biogas",
        "category_id": 63,
        "category_name": "Renewable energy",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 57,
        "sub_category_name": "Green buildings",
        "category_id": 64,
        "category_name": "Green buildings",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 58,
        "sub_category_name": "Sustainable forestry",
        "category_id": 65,
        "category_name": "Sustainable forestry",
        "sdg": {
            "13": "Climate action",
            "15": "Life on land"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 59,
        "sub_category_name": "Biogas/electrical buses and electrical cars",
        "category_id": 66,
        "category_name": "Clean transportation",
        "sdg": {
            "11": "Sustainable cities and communities",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 60,
        "sub_category_name": "Electric trains",
        "category_id": 66,
        "category_name": "Clean transportation",
        "sdg": {
            "11": "Sustainable cities and communities",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 61,
        "sub_category_name": "Energy efficiency",
        "category_id": 67,
        "category_name": "Energy efficiency",
        "sdg": {
            "7": "Affordable and clean energy",
            "11": "Sustainable cities and communities"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 62,
        "sub_category_name": "Pollution prevention and control",
        "category_id": 68,
        "category_name": "Pollution prevention and control",
        "sdg": {
            "7": "Affordable and clean energy",
            "11": "Sustainable cities and communities"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "sub_category_id": 63,
        "sub_category_name": "Circular economy",
        "category_id": 69,
        "category_name": "Circular economy",
        "sdg": {
            "11": "Sustainable cities and communities",
            "12": "Responsible consumption and production"
        },
        "eu_objective": {},
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getSubCategories",
    "parameters": {
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Returns the super indicators of the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to retrieve all super indicators of your taxonomy.

Request Body

[
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 63,
        "category_name": "Renewable energy",
        "language": "English"
    },
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 64,
        "category_name": "Green buildings",
        "language": "English"
    },
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 65,
        "category_name": "Sustainable forestry",
        "language": "English"
    },
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 66,
        "category_name": "Clean transportation",
        "language": "English"
    },
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 67,
        "category_name": "Energy efficiency",
        "language": "English"
    },
    {
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "category_id": 69,
        "category_name": "Circular economy",
        "language": "English"
    },
    {
        "super_indicator_id": 29,
        "super_indicator_name": "Effect",
        "category_id": 63,
        "category_name": "Renewable energy",
        "language": "English"
    },
    {
        "super_indicator_id": 29,
        "super_indicator_name": "Effect",
        "category_id": 67,
        "category_name": "Energy efficiency",
        "language": "English"
    },
    {
        "super_indicator_id": 29,
        "super_indicator_name": "Effect",
        "category_id": 68,
        "category_name": "Pollution prevention and control",
        "language": "English"
    },
    {
        "super_indicator_id": 30,
        "super_indicator_name": "Annual electricity/energy production",
        "category_id": 63,
        "category_name": "Renewable energy",
        "language": "English"
    },
    {
        "super_indicator_id": 30,
        "super_indicator_name": "Annual electricity/energy production",
        "category_id": 67,
        "category_name": "Energy efficiency",
        "language": "English"
    },
    {
        "super_indicator_id": 31,
        "super_indicator_name": "Annual energy savings",
        "category_id": 64,
        "category_name": "Green buildings",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getSuperIndicators",
    "parameters": {
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Returns the indicators and super indicators of the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to retrieve all indicators of your taxonomy.

Request Body

[
    {
        "indicator_id": 34,
        "indicator_name": "Annual emission reduction",
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "language": "English"
    },
    {
        "indicator_id": 35,
        "indicator_name": "Effect",
        "super_indicator_id": 29,
        "super_indicator_name": "Effect",
        "language": "English"
    },
    {
        "indicator_id": 36,
        "indicator_name": "Annual electricity/energy production",
        "super_indicator_id": 30,
        "super_indicator_name": "Annual electricity/energy production",
        "language": "English"
    },
    {
        "indicator_id": 37,
        "indicator_name": "Annual energy savings",
        "super_indicator_id": 31,
        "super_indicator_name": "Annual energy savings",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getIndicators",
    "parameters": {
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Returns the units of the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to retrieve all units of your taxonomy.

Request Body

[
    {
        "unit_id": 25,
        "unit_name": "CO2e kg",
        "language": "English"
    },
    {
        "unit_id": 26,
        "unit_name": "kW",
        "language": "English"
    },
    {
        "unit_id": 27,
        "unit_name": "MWh",
        "language": "English"
    }
]

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "getUnits",
    "parameters": {
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

Adds and updates a category to the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add a category to your taxonomy.

Request Body

{
    "message": "Category was successfully added (id). 67"
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addCategory",
    "parameters": {
        "category_name": "Circular economy",
        "reporting_year": 2023,
        "category_name_changed": "",
        "language_code": "en"
        }
    }

Adds and updates a sub category to the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add a sub category to your taxonomy.

Request Body

{
    "message": "Sub category name was successfully changed."
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addSubCategory",
    "parameters": {
        "sub_category_name": "Circular economy",
        "category_id": 69,
        "reporting_year": 2023,
        "sub_category_name_changed": "",
        "category_id_changed": "",
        "language_code": "en"
        }
    }

Adds a SDG and EU Objective to a sub category for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add SDGs and EU Environmental Objectives to a sub category of your taxonomy.

Request Body

{
    "message": "SDG was successfully added."
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addGoalObjectiveToSubCategory",
    "parameters": {
        "sub_category_id": 63,
        "reporting_year": 2023,
        "sdg_id": 12,
        "eu_objective_id": ""
        }
    }

Adds and updates a unit to the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add a unit to your taxonomy.

Request Body

{
    "message": "Unit was successfully added (id). 45"
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addUnit",
    "parameters": {
        "unit_name": "MWh",
        "reporting_year": 2023,
        "unit_name_changed": "",
        "language_code": "en"
        }
    }

Adds and updates a super indicator to the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add a super category to your taxonomy.

Request Body

{
    "message": "Super indicator name was successfully changed."
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addSuperIndicator",
    "parameters": {
        "super_indicator_name": "Annual energy savings",
        "category_id": 64,
        "reporting_year": 2023,
        "super_indicator_name_changed": "",
        "category_id_changed": "",
        "language_code": "en"
        }
    }

Adds and updates an indicator to the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation to add an indicator to your taxonomy.

Request Body

{
    "message": "Indicator was sucessfully added (id). 23"
}

Operation parameters

Example code

curl --location 'https://api.bws.ninja/v1/call' \
--header 'X-Api-Key: API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "solution": "BWS.ESG.Credits",
    "operation": "addIndicator",
    "parameters": {
        "indicator_name": "Annual energy savings",
        "super_indicator_id": 31,
        "unit_id": 27,
        "reporting_year": 2023,
        "indicator_name_changed": "",
        "super_indicator_id_changed": "",
        "unit_id_changed": "",
        "language_code": "en"
        }
    }

Returns the taxonomy for a particular reporting year

POST https://api.bws.ninja/v1/call

Use this operation retrieve your stored taxonomy.

Request Body

[
    {
        "category_id": 63,
        "category_name": "Renewable energy",
        "sub_category_id": 55,
        "sub_category_name": "Wind power",
        "super_indicator_id": 28,
        "super_indicator_name": "Annual emission reduction",
        "indicator_id": 34,
        "indicator_name": "Annual emission reduction",
        "unit_id": 25,
        "unit_name": "CO2e kg",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "category_id": 63,
        "category_name": "Renewable energy",
        "sub_category_id": 55,
        "sub_category_name": "Wind power",
        "super_indicator_id": 29,
        "super_indicator_name": "Effect",
        "indicator_id": 35,
        "indicator_name": "Effect",
        "unit_id": 26,
        "unit_name": "kW",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},