Frameworks
This section has operations to build up green frameworks to which green assets will be tied
Last updated
Was this helpful?
This section has operations to build up green frameworks to which green assets will be tied
Last updated
Was this helpful?
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve green frameworks registered in ESG.Credits data repository.
solution*
string
BWS.ESG.Credits
operation*
string
getFrameworks
parameters*
JSON
check Operation parameters
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.
POST
https://api.bws.ninja/v1/call
Use this operations to retrieve green framework details.
solution*
string
BWS.ESG.Credits
operation*
string
getFrameworkDetails
parameters*
JSON
check Operation parameters
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.
POST
https://api.bws.ninja/v1/call
Use this operation to add green frameworks to the ESG.Credits data repository.
solution*
string
BWS.ESG.Credits
operation*
string
addFramework
parameters*
JSON
check Operation parameters
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.
POST
https://api.bws.ninja/v1/call
Use this operation to set up the green framework with details that are year specific.
solution*
string
BWS.ESG.Credits
operation*
string
addYearSpecificsToFramework
parameters
JSON
check Operation parameters
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
POST
https://api.bws.ninja/v1/call
Use this operation to set up the different impact categories, indicators, and units, with specified values.
solution*
string
BWS.ESG.Credits
operation*
string
addCategoryIndicatorToFramework
parameters*
JSON
check Operation parameters
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
POST
https://api.bws.ninja/v1/call
solution*
string
BWS.ESG.Credits
operation*
string
removeIndicatorFromFramework
parameters*
JSON
check Operation parameters
framework_identifier
string
yes
indicator_id
number/integer
yes
sub_category_id
number/integer
yes
reporting_year
number/4 digits
yes
POST
https://api.bws.ninja/v1/call
solution*
string
BWS.ESG.Credits
operation*
string
check Operation parameters
parameters*
string
check Operation parameters
framework_identifier
string
yes
sub_category_id
number/integer
yes
reporting_year
number/4 digits
yes
POST
https://api.bws.ninja/v1/call
solution*
string
BWS.ESG.Credits
operation*
string
removeFrameworkYearSpecifics
parameters*
JSON
check Operation parameters
framework_identifier
string
yes
reporting_year
number/4 digits
yes
POST
https://api.bws.ninja/v1/call
solution*
string
BWS.ESG.Credits
operation*
string
removeFramework
parameters*
JSON
check Operation parameters
framework_identifier
string
yes