Update Waste Water Treatment
const options = {
method: 'PATCH',
headers: {
'x-api-key': '<x-api-key>',
'x-organization-id': '<x-organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
start_date: '<string>',
end_date: '<string>',
m3_water_in: 123,
m3_water_out: 123,
kg_sludge: 123,
kg_bod_per_m3_wwt_line: 123,
kg_bod_per_kg_sludge_line: 123,
kg_bod_per_m3_wwd_line: 123,
kg_n_per_m3_wwt_line: 123,
kg_n_per_m3_wwd_line: 123,
kg_r_wwt_line: {},
kg_r_sludge_line: {},
file_url: {},
file_id: {}
})
};
fetch('https://api.dcycle.io/v1/waste-water-treatments/{wwt_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/waste-water-treatments/{wwt_id}"
payload = {
"name": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"m3_water_in": 123,
"m3_water_out": 123,
"kg_sludge": 123,
"kg_bod_per_m3_wwt_line": 123,
"kg_bod_per_kg_sludge_line": 123,
"kg_bod_per_m3_wwd_line": 123,
"kg_n_per_m3_wwt_line": 123,
"kg_n_per_m3_wwd_line": 123,
"kg_r_wwt_line": {},
"kg_r_sludge_line": {},
"file_url": {},
"file_id": {}
}
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)curl --request PATCH \
--url https://api.dcycle.io/v1/waste-water-treatments/{wwt_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>' \
--data '
{
"name": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"m3_water_in": 123,
"m3_water_out": 123,
"kg_sludge": 123,
"kg_bod_per_m3_wwt_line": 123,
"kg_bod_per_kg_sludge_line": 123,
"kg_bod_per_m3_wwd_line": 123,
"kg_n_per_m3_wwt_line": 123,
"kg_n_per_m3_wwd_line": 123,
"kg_r_wwt_line": {},
"kg_r_sludge_line": {},
"file_url": {},
"file_id": {}
}
'Update Waste Water Treatment
Edit a measurement period of a waste water facility and recalculate its emissions
PATCH
/
v1
/
waste-water-treatments
/
{wwt_id}
Update Waste Water Treatment
const options = {
method: 'PATCH',
headers: {
'x-api-key': '<x-api-key>',
'x-organization-id': '<x-organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
start_date: '<string>',
end_date: '<string>',
m3_water_in: 123,
m3_water_out: 123,
kg_sludge: 123,
kg_bod_per_m3_wwt_line: 123,
kg_bod_per_kg_sludge_line: 123,
kg_bod_per_m3_wwd_line: 123,
kg_n_per_m3_wwt_line: 123,
kg_n_per_m3_wwd_line: 123,
kg_r_wwt_line: {},
kg_r_sludge_line: {},
file_url: {},
file_id: {}
})
};
fetch('https://api.dcycle.io/v1/waste-water-treatments/{wwt_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.dcycle.io/v1/waste-water-treatments/{wwt_id}"
payload = {
"name": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"m3_water_in": 123,
"m3_water_out": 123,
"kg_sludge": 123,
"kg_bod_per_m3_wwt_line": 123,
"kg_bod_per_kg_sludge_line": 123,
"kg_bod_per_m3_wwd_line": 123,
"kg_n_per_m3_wwt_line": 123,
"kg_n_per_m3_wwd_line": 123,
"kg_r_wwt_line": {},
"kg_r_sludge_line": {},
"file_url": {},
"file_id": {}
}
headers = {
"x-api-key": "<x-api-key>",
"x-organization-id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)curl --request PATCH \
--url https://api.dcycle.io/v1/waste-water-treatments/{wwt_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--header 'x-organization-id: <x-organization-id>' \
--data '
{
"name": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"m3_water_in": 123,
"m3_water_out": 123,
"kg_sludge": 123,
"kg_bod_per_m3_wwt_line": 123,
"kg_bod_per_kg_sludge_line": 123,
"kg_bod_per_m3_wwd_line": 123,
"kg_n_per_m3_wwt_line": 123,
"kg_n_per_m3_wwd_line": 123,
"kg_r_wwt_line": {},
"kg_r_sludge_line": {},
"file_url": {},
"file_id": {}
}
'Edit a waste water treatment (WWT) record. Only the fields you send change; the rest keep their stored values. Dcycle then recalculates the CH4 and N2O emissions of the period asynchronously: the record answers
status: "loading" until the new emissions are stored (uploaded), or error if the calculation fails.
Request
Headers
string
required
Your API key for authenticationExample:
sk_live_1234567890abcdefstring
required
Your organization UUIDExample:
a8315ef3-dd50-43f8-b7ce-d839e68d51faPath Parameters
string
required
UUID of the waste water treatment record. It can belong to your organization or to a subsidiary you can write to.Example:
550e8400-e29b-41d4-a716-446655440000Body Parameters
Every field is optional and takes the same values as in the create. Onlykg_r_wwt_line, kg_r_sludge_line, file_url and file_id accept null.
string
Name or reference of the measurement. Returned as
invoice_id.date
Start of the measured period (
YYYY-MM-DD). The period, with the stored date you do not send, must not end before it starts.date
End of the measured period (
YYYY-MM-DD)number
Influent water volume (m³),
0 or greater. Like every numeric field below.number
Effluent water volume (m³)
number
Sludge produced (kg)
number
BOD concentration of the influent, WWT line (kg BOD/m³)
number
BOD content of the sludge, sludge line (kg BOD/kg sludge)
number
BOD concentration of the effluent, WWD line (kg BOD/m³)
number
Nitrogen concentration of the influent, WWT line (kg N/m³)
number
Nitrogen concentration of the effluent, WWD line (kg N/m³)
number | null
CH4 recovered in the WWT line (kg)
number | null
CH4 recovered in the sludge line (kg)
string | null
Supporting document: a URL, or the document itself as a base64 data URI (stored by Dcycle). A different value replaces the stored document and its name;
null or "" removes it.string | null
UUID of an uploaded file of My files to attach instead: the record stores its URL and name.
null removes the attachment. Not together with a data URI in file_url.Response
Returns200 OK with the record in the shape of GET /v1/waste-water-treatments/{wwt_id}/detail, with status: "loading". Fetch the detail later to read the recalculated co2e.
Example
cURL
curl -X PATCH "https://api.dcycle.io/v1/waste-water-treatments/550e8400-e29b-41d4-a716-446655440000" \
-H "x-api-key: ${DCYCLE_API_KEY}" \
-H "x-organization-id: ${DCYCLE_ORG_ID}" \
-H "Content-Type: application/json" \
-d '{"m3_water_in": 130000, "kg_sludge": 50000}'
Common Errors
404 Not Found
Cause: The record does not exist, or it belongs to an organization you cannot write to. Also afile_id that is not an uploaded file you may attach to the record.
{
"detail": "WasteWaterTreatment with id='550e8400-e29b-41d4-a716-446655440000' not found",
"code": "NOT_FOUND"
}
422 Validation Error
Cause: A negative number,null on a field that takes none, end_date before start_date (code INVALID_DATE_RANGE when one of them is the stored date), or file_id together with a data URI in file_url.
Related Endpoints
Get Waste Water Treatment
Read a record and its calculated emissions
Delete Waste Water Treatments
Delete records by id with their emissions
Was this page helpful?