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
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getSDGs |
parameters | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
reporting_year | number/integer | yes | Year of the taxonomy |
Example code
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
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
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
indicator_id | number/integer | yes | |
reporting_year | number/4 digits | yes | |
Example code
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
super_indicator_id | number/integer | yes | |
reporting_year | number/4 digits | yes |
Example code
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
unit_id | number/integer | yes | |
reporting_year | number/4 digits | yes |
Example code
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
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
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
sub_category_id | number/integer | yes | |
reporting_year | number/4 digits | yes |
Example code
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
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
category_id | number/integer | yes | |
reporting_year | number/4 digits | yes |
Example code
Last updated