Blockchain
This section has operations to read from and write to the blockchain
Reads the status from the blockchain for a particular job id
POST
https://api.bws.ninja/v1/call
Use this operation to get an update on the status of the blockchain entry.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getJobStatusFromBlockchain |
parameters* | JSON | check Operation parameters |
Example response
See BWS.Blockchain.Fetch
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
job_id | string | yes | String identifier for the blockchain entry |
Example code
Writes a framework to the blockchain for a particular reporting year (HTML format)
POST
https://api.bws.ninja/v1/call
Use this operation to write your Green Bond Framework, or similar, to the blockchain e.g. for increased committment and trust. This operation writes the framework data in html-tabular format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | writeHtmlFrameworkToBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
See operation BWS.Blockchain.Save
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
framework_identifier | string | yes | String identifier for the framework |
reporting_year | number/4 digits | yes | Year of the taxonomy |
solution | string | yes | BWS solution to be used |
operation | string | yes | BWS operation to be used |
version | number/integer | yes | BWS version to be used |
network | string | yes | Blockchain network to be used |
decimals | number/integer | no | Number of decimals in numeral output |
sdg_goals_included | string | no | Select "yes" to include UN SDGs in the output, otherwise "no" |
eu_objectives_included | string | no | Select "yes"to include EU Environmental Objectives in the output, otherwise "no" |
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
Writes a framework to the blockchain for a particular reporting year (JSON format)
POST
https://api.bws.ninja/v1/call
Use this operation to write your Green Bond Framework, or similar, to the blockchain e.g. for increased committment and trust. This operation writes the framework data in JSON format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | writeJsonFrameworkToBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
See operation BWS.Blockchain.Save
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
framework_identifier | string | yes | String identifier for the framework |
reporting_year | number/4 digits | yes | Year of the taxonomy |
solution | string | yes | BWS solution to be used |
operation | string | yes | BWS operation to be used |
version | number/integer | yes | BWS version to be used |
network | string | yes | Blockchain network to be used |
decimals | number/integer | no | Number of decimals in numeral output |
sdg_goals_included | string | no | Select "yes" to include UN SDGs in the output, otherwise "no" |
eu_objectives_included | string | no | Select "yes"to include EU Environmental Objectives in the output, otherwise "no" |
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
Writes the impacts of a particular investment in a green asset to the blockchain (HTML format)
POST
https://api.bws.ninja/v1/call
Use this operation to write a position's impact benefits to the blockchain to e.g. get a certificate to offset negative impacts. This operation writes the position impact data in html-tabular format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | writeHtmlPositionImpactsToBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
See operation BWS.Blockchain.Save
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
position_id | number/integer | yes | Integer identifier for the investment |
reporting_year | number/4 digits | yes | Year of the taxonomy |
solution | string | yes | BWS solution to be used |
operation | string | yes | BWS operation to be used |
version | number/integer | yes | BWS version to be used |
network | string | yes | Blockchain network to be used |
decimals | number/integer | no | Number of decimals in numeral output |
sdg_goals_included | string | no | Select "yes" to include UN SDGs in the output, otherwise "no" |
eu_objectives_included | string | no | Select "yes"to include EU Environmental Objectives in the output, otherwise "no" |
write_investor_to_blockchain | string | no | Select "yes" to include PII to the output, default is "no" |
decryption_key | string | no | For decrypting personally identifiable information |
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
Writes the impacts of a particular investment in a green asset to the blockchain (JSON format)
POST
https://api.bws.ninja/v1/call
Use this operation to write a position's impact benefits to the blockchain to e.g. get a certificate to offset negative impacts. This operation writes the position impact data in JSON format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | writeJsonPositionImpactsToBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
See operation BWS.Blockchain.Save
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
position_id | number/integer | yes | Integer identifier for the investment |
reporting_year | number/4 digits | yes | Year of the taxonomy |
solution | string | yes | BWS solution to be used |
operation | string | yes | BWS operation to be used |
version | number/integer | yes | BWS version to be used |
network | string | yes | Blockchain network to be used |
decimals | number/integer | no | Number of decimals in numeral output |
sdg_goals_included | string | no | Select "yes" to include UN SDGs in the output, otherwise "no" |
eu_objectives_included | string | no | Select "yes"to include EU Environmental Objectives in the output, otherwise "no" |
write_investor_to_blockchain | string | no | Select "yes" to include PII to the output, default is "no" |
decryption_key | string | no | For decrypting personally identifiable information |
language_code | string | no | Language codes as per getLanguages. Default is the original language. |
Example code
Returns the framework data as written on the blockchain (HTML format)
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve a framework from the blockchain e.g. for increased committment and trust. This operation presents the framework data in html-tabular format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getHtmlFrameworkFromBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
job_id | string | yes | String identifier for the blockchain entry |
Example code
Returns the framework data as written on the blockchain (JSON format)
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve a framework from the blockchain e.g. for increased committment and trust. This operation presents the framework data in JSON format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getJsonFrameworkFromBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
TBD
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
job_id | string | yes | String identifier for the blockchain entry |
Example code
Returns the impact data for an investment as written to the blockchain (HTML format)
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve a position's impact benefits from the blockchain to e.g. get a certificate to offset negative impacts. This operation presents the position's impact data in html-tabular format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
parameters | JSON | Check Operation parameters |
operation | string | getHtmlPositionImpactsFromBlockchain |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
job_id | string | yes | String identifier for the blockchain entry |
Example code
Returns the impact data for an investment in a green asset as written to the blockchain (JSON format)
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve a position's impact benefits from the blockchain to e.g. get a certificate to offset negative impacts. This operation presents the position's impact data in JSON format.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getJsonPositionImpactsFromBlockchain |
parameters* | JSON | check Operation parameters |
Example responses
TBD
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
job_id | string | yes | String identifier for the blockchain entry |
Example code
Returns the blockchain job IDs for a particular framework
POST
https://api.bws.ninja/v1/call
Use this operation to retrieve the blockchain entries made for frameworks.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getBlockchainJobsForFrameworks |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
framework_identifier | string | yes | String identifier for the framework |
Example code
Returns the blockchain job IDs for a particular investor
POST
/call
Use this operation to retrieve the blockchain entries made for position impact benefits.
Request Body
Name | Type | Description |
---|---|---|
solution* | string | BWS.ESG.Credits |
operation* | string | getBlockchainJobsForImpacts |
parameters* | JSON | check Operation parameters |
Example responses
Operation parameters
Parameter | Type/Format | Required | Description |
---|---|---|---|
investor_identifier | string | yes | String identifier for the investor |
position_id | number/integer | yes | Integer identifier for the investment |
Example code
Last updated