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.

getSDGs

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getSDGs
parameters	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "More details are needed to retrieve SDGs."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getEUObjectives

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getEUObjectives
parameters	string	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "More details are needed to retrieve EU Objectives."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getCategories

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getCategories
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No such categories registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number/4 digits	yes	Year of the taxonomy
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getSubCategories

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getSubCategories
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No such sub categories registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number, 4 digits	yes	Year of the taxonomy
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getSuperIndicators

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getSuperIndicators
parameters*	JSON	check Operation arameters

Example responses

200: OK Successful operation (example)

[
    {
        "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": 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": 31,
        "super_indicator_name": "Annual energy savings",
        "category_id": 64,
        "category_name": "Green buildings",
        "language": "English"
    }
]

400: Bad Request Error message (example)

{
    "message": "No such super indicators registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number, 4 digits	yes	Year of the taxonomy
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getIndicators

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getIndicators
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No such indicators registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number, 4 digits	yes	Year of the taxonomy
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

getUnits

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getUnits
parameters*	string	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No such units registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number, 4 digits	yes	Year of the taxonomy
language_code	string	no	Language codes as per getLanguages. Default is the original language.

Example code

curl

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"
        }
    }

addCategory

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addCategory
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "Suggested category name to change was not found."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
category_name	string	yes	Category name to add or change
reporting_year	number/4 digits	yes	Year of the taxonomy
category_name_changed	string	no	New category name
language_code	string	yes	Selection of original language code as per getLanguages

Example code

curl

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"
        }
    }

addSubCategory

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addSubCategory
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "Suggested sub category name is already in use."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
sub_category_name	string	yes	Sub category name to add or change
category_id	number/integer	yes	Integer identifier for a category
reporting_year	number/4 digits	yes	Year of the taxonomy
sub_category_name_changed	string	no	New sub category name
language_code	string	yes	Selection of original language code as per getLanguages

Example code

curl

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"
        }
    }

addGoalObjectiveToSubCategory

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addGoalObjectiveToSubCategory
parameters*	string	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "That SDG is already assigned to this sub category."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
sub_category_id	number, integer	yes	Integer identifier for a sub category
reporting_year	number/4 digits	yes	Year of the taxonomy
sdg_id	number/integer	no	Integer identifier for an SDG
eu_objective_id	number/integer	no	Integer identifier for an EU Environmental Objective

Example code

curl

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": ""
        }
    }

addUnit

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addUnit
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No unit possible to register for that language code."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
unit_name	string	yes	Unit name to add or change
reporting_year	number/4 digits	yes	Year of the taxonomy
unit_name_changed	string	no	New unit name
language_code	string	yes	Selection of original language code as per getLanguages

Example code

curl

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"
        }
    }

addSuperIndicator

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addSuperIndicator
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "No such super indicator for that reporting year."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
super_indicator_name	string	yes	Super indicator name to add or change
category_id	number/integer	yes	Integer identifier for a category
reporting_year	number/4 digits	yes	Year of the taxonomy
super_indicator_name_changed	string	no	New super indicator name
category_id_changed	number/integer	no	New category id
language_code	string	yes	Selection of original language code as per getLanguages

Example code

curl

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"
        }
    }

addIndicator

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

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	addIndicator
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "Suggested indicator name is already in use."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
indicator_name	string	yes	Indicator name to add or change
super_indicator_id	number/integer	yes	Integer identifier for a super indicator
unit_id	number/integer	yes	Integer identifier for a unit
reporting_year	number/4 digits	yes	Year of the taxonomy
indicator_name_changed	string	no	New indicator name
super_indicator_id_changed	number/integer	no	New super indicator id
unit_id_changed	number/integer	no	New unit id
language_code	string	yes	Selection of original language code as per getLanguages

Example code

curl

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"
        }
    }

getTaxonomy

Returns the taxonomy for a particular reporting year

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

Use this operation retrieve your stored taxonomy.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	getTaxonomy
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

[
    {
        "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": 56,
        "sub_category_name": "Hydro- and solar power, biogas",
        "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": 56,
        "sub_category_name": "Hydro- and solar power, biogas",
        "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": {},
        "language": "English"
    },
    {
        "category_id": 64,
        "category_name": "Green buildings",
        "sub_category_id": 57,
        "sub_category_name": "Green buildings",
        "super_indicator_id": 31,
        "super_indicator_name": "Annual energy savings",
        "indicator_id": 37,
        "indicator_name": "Annual energy savings",
        "unit_id": 27,
        "unit_name": "MWh",
        "sdg": {
            "7": "Affordable and clean energy",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "category_id": 65,
        "category_name": "Sustainable forestry",
        "sub_category_id": 58,
        "sub_category_name": "Sustainable forestry",
        "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": {
            "13": "Climate action",
            "15": "Life on land"
        },
        "eu_objective": {},
        "language": "English"
    },
    {
        "category_id": 66,
        "category_name": "Clean transportation",
        "sub_category_id": 59,
        "sub_category_name": "Biogas/electrical buses and electrical cars",
        "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": {
            "11": "Sustainable cities and communities",
            "13": "Climate action"
        },
        "eu_objective": {},
        "language": "English"
    }
]

400: Bad Request Error message (example)

{
    "message": "No such taxonomy registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number/integer	yes	Year of the taxonomy

Example code

curl

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": "getTaxonomy",
    "parameters": {
        "reporting_year": 2023
        }
    }

copyTaxonomyToNewYear

Copies a taxonomy from one reporting year to another reporting year

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

Use this operation to copy your taxonomy to a new year.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	copyTaxonomyToNewYear
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Taxonomy was successfully copied."
}

400: Bad Request Error message (see example)

{
    "message": "Not copied, taxonomy already exists for target year."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
source_year	number/4 digits	yes	Source year of the taxonomy
target_year	number/4 digits	yes	Target year of the taxonomy

Example code

curl

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": "copyTaxonomyToNewYear",
    "parameters": {
        "source_year": 2022,
        "target_year": 2023
        }
    }

removeIndicator

Removes an indicator

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

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeIndicator
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Indicator was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "Cannot remove indicator. Still used in a framework."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
indicator_id	number/integer	yes
reporting_year	number/4 digits	yes

Example code

curl

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": "removeIndicator",
    "parameters": {
        "indicator_id": 13,
        "reporting_year": 2023
        }
    }

removeSuperIndicator

Removes a super indicator

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

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeSuperIndicator
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Super indicator was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "No such super indicator."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
super_indicator_id	number/integer	yes
reporting_year	number/4 digits	yes

Example code

curl

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": "removeSuperIndicator",
    "parameters": {
        "super_indicator_id": 56,
        "reporting_year": 2023
        }
    }

removeUnit

Removes a unit

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

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeUnit
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Unit was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "Cannot remove unit. Still referred to by an indicator."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
unit_id	number/integer	yes
reporting_year	number/4 digits	yes

Example code

curl

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": "removeUnit",
    "parameters": {
        "unit_id": 14,
        "reporting_year": 2023
        }
    }

removeGoalObjectiveFromSubCategory

Removes an SDG and EU Objective from a sub category

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

Use this operation to remove SDGs and EU Environmental Objectives from your taxonomy.

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeGoalObjectiveFromSubCategory
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

{
    "message": "The SDG was successfully removed from this sub category."
}

400: Bad Request Error message (example)

{
    "message": "That SDG does not exist for this sub category."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
reporting_year	number/4 digits	yes	Year of the taxonomy
sub_category_id	number/integer	yes	Integer identifier for a sub category
sdg_id	number/integer	yes	Integer identifier for an SDG
eu_objective_id	number/integer	yes	Integer identifier for an EU Environmental Objective

Example code

curl

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": "removeGoalObjectiveFromSubCategory"
    "parameters": {
        "reporting_year": 2023
        "sub_category_id": 13
        "sdg_id": 4
        "eu_objective_id": 2
        }
    }

removeSubCategory

Removes a sub category

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

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeSubCategory
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Sub category was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "Cannot remove sub category. Position needs to be removed first."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
sub_category_id	number/integer	yes
reporting_year	number/4 digits	yes

Example code

curl

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": "removeSubCategory",
    "parameters": {
        "sub_category_id": 35,
        "reporting_year": 2023
        }
    }

removeCategory

Removes a category

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

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeCategory
parameters*	JSON	check Operation parameters

Example responses

200: OK Successful operation

{
    "message": "Category was successfully removed."
}

400: Bad Request Error message (example)

{
    "message": "Cannot remove category. Still referred to by a sub category."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
category_id	number/integer	yes
reporting_year	number/4 digits	yes

Example code

curl

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": "removeCategory",
    "parameters": {
        "category_id": 57,
        "reporting_year": 2023
        }
    }