Frameworks

This section has operations to build up green frameworks to which green assets will be tied

getFrameworks

Returns private or public green frameworks for a particular reporting year

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

Use this operation to retrieve green frameworks registered in ESG.Credits data repository.

Request Body

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

Example responses

200: OK Successful operation (example)

[
    {
        "framework_id": 3,
        "framework_identifier": "greenbond",
        "framework_name": "Good Bank Green Bond Framework",
        "framework_value_outstanding": 22224856800,
        "framework_allocated_amount": 22224856800,
        "framework_active_percentage": 1.0,
        "framework_currency_code": "SEK",
        "value_outstanding_framework": "yes",
        "framework_visibility": "private"
    }
]

400: Bad Request Error message (example)

{
    "message": "No such framework is 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
framework_visibility	string	no	Public or private. Default is private, meaning not visible across different BWS accounts.

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

getFrameworkDetails

Returns details about a green framework for a particular reporting year

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

Use this operations to retrieve green framework details.

Request Body

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

Example responses

200: OK Successful operation (sexample)

[
    {
        "framework_id": 3,
        "framework_identifier": "greenbond",
        "framework_name": "Good Bank Green Bond Framework",
        "framework_value_outstanding": 22224856800,
        "framework_allocated_amount": 22224856800,
        "framework_active_percentage": 1.0,
        "framework_currency_code": "SEK",
        "value_outstanding_framework": "yes",
        "framework_visibility": "private",
        "framework": [
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "sub_category_volume": 11540605381,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 899034000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 67,
                "category_name": "Energy efficiency",
                "sub_category_id": 61,
                "sub_category_name": "Energy efficiency",
                "sub_category_volume": 304535860,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 79697000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "11": "Sustainable cities and communities"
                },
                "eu_objective": {},
                "language": "English"
            },
            {
                "category_id": 69,
                "category_name": "Circular economy",
                "sub_category_id": 63,
                "sub_category_name": "Circular economy",
                "sub_category_volume": 15578758,
                "framework_currency_code": "SEK",
                "super_indicator_id": 28,
                "super_indicator_name": "Annual emission reduction",
                "indicator_id": 34,
                "indicator_name": "Annual emission reduction",
                "indicator_value": 2386000.0,
                "unit_id": 25,
                "unit_name": "CO2e kg",
                "year": 2022,
                "sdg": {
                    "11": "Sustainable cities and communities",
                    "12": "Responsible consumption and production"
                },
                "eu_objective": {},
                "language": "English"
            }
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "No taxonomy and impact values are available for that reporting year and/or framework and/or language code."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes	String identifier for a framework
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": "getFrameworkDetails",
    "parameters": {
        "framework_identifier": "greenbond",
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

addFramework

Creates and updates the information about a green framework

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

Use this operation to add green frameworks to the ESG.Credits data repository.

Request Body

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

Example responses

200: OK Successful operation

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

400: Bad Request Error message (example)

{
    "message": "Public assets exists. Framework cannot be made private."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes	String identifier for a framework
framework_name	string	yes	Framework name
framework_currency_code	string	yes	Currency code of the framework, as per getCurrencies
framework_visibility	string	no	Public or private. Default is private, meaning not visible across different BWS accounts.

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": "addFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "framework_name": "Green Bond Framework",
        "framework_currency_code": "SEK",
        "framework_visibility": "private"
        }
    }

addYearSpecificsToFramework

Adds reporting year specific details to a green framework

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

Use this operation to set up the green framework with details that are year specific.

Request Body

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

Example responses

200: OK Successful operation

{
    "message": "Year specific data for the framework has been succesfully added."
}

400: Bad Request Error message (example)

{
    "message": "The reporting year does not exist."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes	String identifier for a framework
value_outstanding	number	yes	Amount of funding raised to green projects for the framework as a whole, for the reporting year
allocated_amount	number	yes	Amount of funding allocated to projects for the reporting year of the framework, for the corresponding impacts registered
value_outstanding_framework	string	yes	Choose "yes" when use of proceeds relate to value outstanding, choose "no" when related to allocated amount
reporting_year	number/4 digits	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": "addYearSpecificsToFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "value_outstanding": 22224856800,
        "allocated_amount": 22224856800,
        "value_outstanding_framework": "yes",
        "reporting_year": 2023
        }
    }

addCategoryIndicatorToFramework

Adds and updates category and indicator values to a green framework

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

Use this operation to set up the different impact categories, indicators, and units, with specified values.

Request Body

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

Example responses

200: OK Successful operation

{
    "message": "Category volume / indicator values were successfully added."
}

400: Bad Request Error message (example)

{
    "message": "The indicator does not belong to this category."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes	String identifier for a framework
sub_category_id	number/integer	yes	Integer identifier of a sub category
sub_category_volume	number	yes	Amount of funding / use of proceeds
indicator_id	number/integer	yes	Integer identifier of an indicator
indicator_value	number	yes	ESG benefit value, in the unit specified by the taxonomy
reporting_year	number/4 digits	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": "addCategoryIndicatorToFramework",
    "parameters": {
 	"framework_identifier": "greenbond",
	"sub_category_id": 56,
	"sub_category_volume": 1634937960,
	"indicator_id": 34,
	"indicator_value": 137922,
	"reporting_year": 2023
	}
    }

removeIndicatorFromFramework

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

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Not authorized."
}

400: Bad Request Error message (example)

{
    "message": "Not authorized."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes
indicator_id	number/integer	yes
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": "removeIndicatorFromFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "indicator_id": 34,
        "sub_category_id": 56
        "reporting_year": 2023
        }
    }

removeCategoryFromFramework

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

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Not authorized."
}

400: Bad Request Error message (example)

{
    "message": "Not authorized."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	yes
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": "removeCategoryFromFramework",
    "parameters": {
        "framework_identifier": "greenbond",
        "sub_category_id": 35,
        "reporting_year": 2023
        }
    }

removeFrameworkYearSpecifics

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

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Not authorized."
}

400: Bad Request Error message (example)

{
    "message": "Not authorized."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	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": "removeFrameworkYearSpecifics",
    "parameters": {
        "framework_identifier": "greenbond",
        "reporting_year": 2023
        }
    }

removeFramework

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

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Not authorized."
}

400: Bad Request Error message (example)

{
    "message": "Not authorized."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
framework_identifier	string	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": "removeFramework",
    "parameters": {
        "framework_identifier": "greenbond"
        }
    }