Post Project Component Ghg Entry Attribution

Manually attributes or removes attribution of a project component to a GHG entry.

POST /project_components/{id}/ghg_entry_attributions

Post Project Component Ghg Entry Attribution

cURL

curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "attribution_factor": 0,
  "ghg_entry_id": "rmv_1EEM6NJXX1S0EXKD"
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions"

payload = {
    "attribution_factor": 0,
    "ghg_entry_id": "rmv_1EEM6NJXX1S0EXKD"
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({attribution_factor: 0, ghg_entry_id: 'rmv_1EEM6NJXX1S0EXKD'})
};

fetch('https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attribution_factor' => 0,
    'ghg_entry_id' => 'rmv_1EEM6NJXX1S0EXKD'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions"

	payload := strings.NewReader("{\n  \"attribution_factor\": 0,\n  \"ghg_entry_id\": \"rmv_1EEM6NJXX1S0EXKD\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attribution_factor\": 0,\n  \"ghg_entry_id\": \"rmv_1EEM6NJXX1S0EXKD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/project_components/{id}/ghg_entry_attributions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attribution_factor\": 0,\n  \"ghg_entry_id\": \"rmv_1EEM6NJXX1S0EXKD\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "co2e_net_removed_kg": 123,
  "co2e_net_removed_standard_deviation_kg": 123,
  "co2e_net_removed_without_discount_kg": 123,
  "completed_on": "2023-12-25",
  "credit_allocation": {
    "buffer_pool_contribution_kg": 123,
    "supplier_allocation_kg": 123
  },
  "credit_type": "REMOVAL",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "risk_of_reversal_percentage": 123,
  "started_on": "2023-12-25",
  "supplier_reference_id": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret · string · required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

id · string · required

Required string length: 20 - 37

Examples:

"cmp_1EP2SB7MZ1S036PY"

"cmp_1EHK4R6QJSBXFC5N"

Body

application/json

attribution_factor · number · required

A scalar between 0 and 1 for the fraction of the CO2e flux of the project component that is to be attributed to this GHG entry.

Required range: x <= 1

ghg_entry_id · string · required

ID of the GHG entry to attribute the project component to.

Required string length: 20 - 37

Examples:

"rmv_1EEM6NJXX1S0EXKD"

"rmv_1E3V4J2EWSBX5E82"

Response

200

application/json

Successful Response

co2e_net_removed_kg · number · required

The CO₂e removed by this GHG entry once uncertainty discounting has been applied

co2e_net_removed_standard_deviation_kg · number | null · required

The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the GHG entry

co2e_net_removed_without_discount_kg · number · required

The CO₂e removed by this GHG entry before any uncertainty discounting has been applied

completed_on · string<date> · required

credit_allocation · CreditAllocation · object | null · required

The split of issuable credits between the supplier and buffer pool. Null when risk_of_reversal_percentage is not set.

Show child attributes

credit_type · enum<string> · required

Available options: REDUCTION, REMOVAL

Examples:

"REMOVAL"

"REDUCTION"

feedstock_type_id · string | null · required

The feedstock type ID that this entry is associated with.

Required string length: 20 - 37

Example:

"ftt_1D7KZ1P761S0G7BN"

ghg_statement_id · string | null · required

The GHG statement ID that this entry is associated with. If null, the entry is in draft and has not been submitted for verification.

Required string length: 20 - 37

Example:

"ggs_1GDQJ99Z51S0DYW9"

id · string · required

Required string length: 20 - 37

Examples:

"rmv_1EEM6NJXX1S0EXKD"

"rmv_1E3V4J2EWSBX5E82"

risk_of_reversal_percentage · number | null · required

The percentage of credits contributed to the buffer pool due to risk of reversal.

started_on · string<date> · required

supplier_reference_id · string | null · required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 200