GET api/customers/{customerId}/contracts/{contractNo}/meters/{meterId}/settings
Get settings for a customer's building/meter, e.g. building year, heated area, number of residents.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerId |
Customer ID |
integer |
Required |
| contractNo |
Contract number |
integer |
Required |
| meterId |
Meter ID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Settings
SettingsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId | string |
None. |
|
| MeterId | string |
None. |
|
| Building | Building |
None. |
|
| WattMeterGoal | integer |
None. |
|
| NotificationSettings | NotificationSettings |
None. |
|
| Customer | CustomerResponse |
None. |
|
| Products | Collection of ProductResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"CustomerId": "sample string 1",
"MeterId": "sample string 2",
"Building": {
"Name": "sample string 1",
"BuildingYear": 1,
"HeatingArea": 1,
"Residents": 1
},
"WattMeterGoal": 1,
"NotificationSettings": {
"OperationalMessages": true,
"TimelimitProductAgreementExpiring": true,
"SmartScore": true,
"NewInvoice": true,
"EffectControlExpiring": true
},
"Customer": {
"Address": {
"AddressText": "sample string 1",
"City": "sample string 2",
"CoAddress": "sample string 3",
"CountryCode": "sample string 4",
"Entrance": "sample string 5",
"Floor": "sample string 6",
"HouseLetter": "sample string 7",
"HouseNo": "sample string 8",
"IsEditable": true,
"POBox": 10,
"ZipCode": "sample string 11"
},
"BirthDate": "2025-12-23T04:09:13.6046407+00:00",
"CustomerId": 2,
"CustomerType": "sample string 3",
"Email": "sample string 4",
"FirstName": "sample string 5",
"IsBroadbandCustomer": true,
"IsDistrictHeatingCustomer": true,
"IsNetCustomer": true,
"IsPowerCustomer": true,
"LastName": "sample string 10",
"MobileNumber": "sample string 11",
"OrganizationNo": "sample string 12",
"PhoneNumber": "sample string 13",
"Pin": "sample string 14",
"RequiresProfileConfirmation": true
},
"Products": [
{
"$id": "1",
"ContractNo": 1,
"CustomerId": 2,
"PriceAgreement": {
"$id": "2",
"FromTime": "2025-12-23T04:09:13.6046407+00:00",
"Price": 2.1,
"PriceUnit": "sample string 3",
"ToTime": "2025-12-23T04:09:13.6046407+00:00"
},
"ProductDescription": "sample string 3",
"ProductName": "sample string 4",
"ProductPaymentType": "sample string 5",
"SpecialPriceAgreement": {
"$ref": "2"
}
},
{
"$ref": "1"
}
]
}
text/html
Sample:
{"CustomerId":"sample string 1","MeterId":"sample string 2","Building":{"Name":"sample string 1","BuildingYear":1,"HeatingArea":1,"Residents":1},"WattMeterGoal":1,"NotificationSettings":{"OperationalMessages":true,"TimelimitProductAgreementExpiring":true,"SmartScore":true,"NewInvoice":true,"EffectControlExpiring":true},"Customer":{"Address":{"AddressText":"sample string 1","City":"sample string 2","CoAddress":"sample string 3","CountryCode":"sample string 4","Entrance":"sample string 5","Floor":"sample string 6","HouseLetter":"sample string 7","HouseNo":"sample string 8","IsEditable":true,"POBox":10,"ZipCode":"sample string 11"},"BirthDate":"2025-12-23T04:09:13.6046407+00:00","CustomerId":2,"CustomerType":"sample string 3","Email":"sample string 4","FirstName":"sample string 5","IsBroadbandCustomer":true,"IsDistrictHeatingCustomer":true,"IsNetCustomer":true,"IsPowerCustomer":true,"LastName":"sample string 10","MobileNumber":"sample string 11","OrganizationNo":"sample string 12","PhoneNumber":"sample string 13","Pin":"sample string 14","RequiresProfileConfirmation":true},"Products":[{"$id":"1","ContractNo":1,"CustomerId":2,"PriceAgreement":{"$id":"2","FromTime":"2025-12-23T04:09:13.6046407+00:00","Price":2.1,"PriceUnit":"sample string 3","ToTime":"2025-12-23T04:09:13.6046407+00:00"},"ProductDescription":"sample string 3","ProductName":"sample string 4","ProductPaymentType":"sample string 5","SpecialPriceAgreement":{"$ref":"2"}},{"$ref":"1"}]}