POST request/clevel/calculate/gascarbonoffset
Calculate the Carbon Offset for a given amount of CO2
Request Information
URI Parameters
None.
Body Parameters
GasOffsetPriceBindingModelName | Description | Type | Additional information |
---|---|---|---|
Amount | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "amount": 1 }
application/xml, text/xml
Sample:
<CLevelcarbon.GasOffsetPriceBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.CLevelCarbon"> <Amount>1</Amount> </CLevelcarbon.GasOffsetPriceBindingModel>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Amount" 1 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
GasOffsetPriceResponseName | Description | Type | Additional information |
---|---|---|---|
Co2Total_Kg | decimal number |
None. |
|
Co2Total_Tonne | decimal number |
None. |
|
CurrencyCode | string |
None. |
|
Equvilant_Kwh | integer |
None. |
|
IsServerError | boolean |
None. |
|
IsSuccess | boolean |
None. |
|
JsonResult | string |
None. |
|
QuoteExpiry | string |
None. |
|
QuoteId | string |
None. |
|
TotalPrice | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{ "equvilant_Kwh": 1, "quoteId": "sample string 2", "currencyCode": "sample string 3", "quoteExpiry": "sample string 4", "co2Total_Kg": 5.0, "co2Total_Tonne": 6.0, "totalPrice": 7.0, "jsonResult": "sample string 8", "isSuccess": true, "isServerError": true }
application/xml, text/xml
Sample:
<CLevelcarbon.GasOffsetPriceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.CLevelCarbon"> <Co2Total_Kg>5</Co2Total_Kg> <Co2Total_Tonne>6</Co2Total_Tonne> <CurrencyCode>sample string 3</CurrencyCode> <Equvilant_Kwh>1</Equvilant_Kwh> <IsServerError>true</IsServerError> <IsSuccess>true</IsSuccess> <JsonResult>sample string 8</JsonResult> <QuoteExpiry>sample string 4</QuoteExpiry> <QuoteId>sample string 2</QuoteId> <TotalPrice>7</TotalPrice> </CLevelcarbon.GasOffsetPriceResponse>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Equvilant_Kwh" 1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="QuoteId" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CurrencyCode" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="QuoteExpiry" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Co2Total_Kg" 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Co2Total_Tonne" 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="TotalPrice" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="JsonResult" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsSuccess" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="IsServerError" True --MultipartDataMediaFormatterBoundary1q2w3e--