Readings

PreviousMeters NextOverview

Last updated 6 months ago

Was this helpful?

Get registers hourly average readings

get

Required permissions: Meter.Organization.Read

Authorizations

Query parameters

organizationIdinteger · int32Required

The organization identifier

registerIdinteger · int32[]Required

The registers identifiers

startstring · date-timeRequired

The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

endstring · date-timeRequired

The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

Responses

get

GET /api/readings/average/hourly HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "registerId": 1,
    "readings": [
      {
        "timestamp": "2025-04-25T07:42:48.978Z",
        "periodTo": "2025-04-25T07:42:48.978Z",
        "updatedAt": "2025-04-25T07:42:48.978Z",
        "value": 1,
        "resolution": 1
      }
    ]
  }
]

Get registers readings

get

Required permissions: Meter.Organization.Read

Authorizations

Query parameters

organizationIdinteger · int32Required

The organization identifier

registerIdinteger · int32[]Required

The registers identifiers

startstring · date-timeRequired

The start date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

endstring · date-timeRequired

The end date and time represented using ISO 8601 format and is always in UTC time, e.g. midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'.

resolutioninteger · int32Optional

The readings resolution in seconds and if not supplied the default value is 0 seconds

Responses

get

GET /api/readings HTTP/1.1
Host: api.switchmarket.se
Accept: */*

[
  {
    "registerId": 1,
    "readings": [
      {
        "timestamp": "2025-04-25T07:42:48.978Z",
        "periodTo": "2025-04-25T07:42:48.978Z",
        "updatedAt": "2025-04-25T07:42:48.978Z",
        "value": 1,
        "resolution": 1
      }
    ]
  }
]

Save readings

post

Required permission is Meter.Organization.ReadWrite in the organization(s) that have access to the meters.

Authorizations

Body

all ofOptional

Responses

post

POST /api/readings HTTP/1.1
Host: api.switchmarket.se
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "meters": [
    {
      "id": "text",
      "registers": [
        {
          "id": "text",
          "values": [
            {
              "timestamp": "2025-04-25T07:42:48.978Z",
              "value": 1,
              "resolution": 1
            }
          ]
        }
      ]
    }
  ]
}

No content