Projects

This section has operations to register projects and their impact characteristics, and one operation to consolidate projects into a green framework

getProjects

Returns private or public green projects for a particular reporting year

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

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

Request Body

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

Example responses

200: OK Successful operation (example)

[
    {
        "project_id": 1,
        "project_identifier": "NWP123",
        "project_name": "Norrbotten wind park",
        "project_allocated_amount": 11540605381,
        "project_currency_code": "SEK",
        "framework_identifier": "project-greenbond",
        "framework_name": "Project Green Bond Framework",
        "project_visibility": "private"
    },
    {
        "project_id": 2,
        "project_identifier": "SSF123",
        "project_name": "Skåne solar farm",
        "project_allocated_amount": 1634937960,
        "project_currency_code": "SEK",
        "framework_identifier": "project-greenbond",
        "framework_name": "Project Green Bond Framework",
        "project_visibility": "private"
    },
    {
        "project_id": 3,
        "project_identifier": "DWP123",
        "project_name": "Dalarna wind park",
        "project_allocated_amount": 12540605381,
        "project_currency_code": "SEK",
        "framework_identifier": "project-greenbond",
        "framework_name": "Project Green Bond Framework",
        "project_visibility": "public"
    }
]

400: Bad Request Error message (example)

{
    "message": "No such project 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
project_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": "getProjects",
    "parameters": {
        "reporting_year": 2023,
        "project_visibility": "public"
        }
    }

getProjectDetails

Returns details about a green project for a particular reporting year

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

Use this operations to retrieve green project details.

Request Body

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

Example responses

200: OK Successful operation (example)

[
    {
        "project_id": 1,
        "project_identifier": "NWP123",
        "project_name": "Norrbotten wind park",
        "project_allocated_amount": 11540605381,
        "project_currency_code": "SEK",
        "framework_identifier": "project-greenbond",
        "framework_name": "Project Green Bond Framework",
        "project_visibility": "private",
        "project": [
            {
                "category_id": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "sub_category_volume": 11540605381,
                "project_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": 63,
                "category_name": "Renewable energy",
                "sub_category_id": 55,
                "sub_category_name": "Wind power",
                "sub_category_volume": 11540605381,
                "project_currency_code": "SEK",
                "super_indicator_id": 29,
                "super_indicator_name": "Effect",
                "indicator_id": 35,
                "indicator_name": "Effect",
                "indicator_value": 1054000.0,
                "unit_id": 26,
                "unit_name": "kW",
                "year": 2022,
                "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",
                "sub_category_volume": 11540605381,
                "project_currency_code": "SEK",
                "super_indicator_id": 30,
                "super_indicator_name": "Annual electricity/energy production",
                "indicator_id": 36,
                "indicator_name": "Annual electricity/energy production",
                "indicator_value": 2854000.0,
                "unit_id": 27,
                "unit_name": "MWh",
                "year": 2022,
                "sdg": {
                    "7": "Affordable and clean energy",
                    "13": "Climate action"
                },
                "eu_objective": {},
                "language": "English"
            }
        ]
    }
]

400: Bad Request Error message (example)

{
    "message": "No such project is registered."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
project_identifier	string	yes	String identifier for a project
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": "getProjectDetails",
    "parameters": {
        "project_identifier": "NWP123"
        "reporting_year": 2023,
        "language_code": "en"
        }
    }

addProject

Creates and updates the information about a green project

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

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

Request Body

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

Example responses

200: OK Successful operation (example)

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

400: Bad Request Error message (example)

{
    "message": "Details are missing to add project."
}

401: Unauthorized Error message

{
    "message": "Not authorized."
}

Operation parameters

Parameter	Type/Format	Required	Description
project_identifier	string	yes	String identifier for a project
project_name	string	yes	Project name
project_currency_code	string	yes	Currency code of the project, as per getCurrencies
framework_identifier	string	yes	String identifier for the framework to be built
project_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": "addProject",
    "parameters": {
        "project_identifier": "NWP123",
        "project_name": "Norrbotten wind park",
        "project_currency_code": "SEK",
        "framework_identifier": "project-greenbond",
        "project_visibility": "private"
        }
    }

addYearSpecificsToProject

Adds reporting year specific details to a green project

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

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

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Year specific data for the project was succesfully changed."
}

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
project_identifier	string	yes	String identifier for a project
allocated_amount	number/integer	yes	Amount of funding allocated to the project for the reporting year of the framework, for the corresponding impacts registered
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": "addYearSpecificsToProject",
    "parameters": {
        "project_identifier": "NWP123",
        "allocated_amount": 11540605381,
        "reporting_year": 2023
        }
    }

addCategoryIndicatorToProject

Adds and updates category and indicator values to a green project

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	addCategoryIndicatorToProject
parameters	JSON	check Operation parameters

Example responses

200: OK Successful operation (example)

{
    "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
project_identifier	string	yes	String identifier for a project
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": "addCategoryIndicatorToProject",
    "parameters": {
	"project_identifier": "NWP123",
	"sub_category_id": 56,
	"sub_category_volume": 1634937960,
	"indicator_id": 34,
	"indicator_value": 137922000,
	"reporting_year": 2023
        }
    }

buildFrameworkFromProjects

Builds a green framework by consolidating benefit characteristics of projects

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

Use this operation to consolidate project impact data into a green framework, as an option to register the framework as a whole. The framework needs to be created and year specifics added. Projects need to refer to the framework.

Request Body

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

Example responses

200: OK Successful operation (example)

{
    "message": "Category volumes / indicator values were successfully added to the framework."
}

400: Bad Request Error message (example)

{
    "message": "The referenced framework 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 to be built from consolidation of associated projects
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": "buildFrameworkFromProjects",
    "parameters": {
        "framework_identifier": "project-greenbond",
	"reporting_year": 2023
        }
    }

removeIndicatorFramProject

POST

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeIndicatorFromProject
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
project_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": "removeIndicatorFromProject",
    "parameters": {
        "project_identifier": "SSF123",
        "indicator_id": 37,
        "sub_category_id": 37,
        "reporting_year": 2023
        }
    }

removeCategoryFromProject

POST

Request Body

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

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
project_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": "removeCategoryFromProject",
    "parameters": {
        "project_identifier": "SSF123",
        "sub_category_id": 56
        "reporting_year": 2023
        }
    }

removeYearSpecificsFromProject

POST

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeYearSpecificsFromProject
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
project_identifer	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": "removeYearSpecificsFromProject",
    "parameters": {
        "project_identifier": "SSF123",
        "reporting_year": 2023
        }
    }

removeProject

POST

Request Body

Name	Type	Description
solution*	string	BWS.ESG.Credits
operation*	string	removeProject
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
project_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": "removeProject",
    "parameters": {
        "project_identifier": "SSF123"
        }
    }