/config/location

The geographic location of the meter.

Get /config/location

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/location
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/location

SecurityApiKey
Request
Request Body schema: application/json
latitude
number (configLocationLatitude)

The latitude of the meter's location in degrees. Positive values are north of the equator, negative values south of it.

longitude
number (configLocationLongitude)

The longitude of the meter's location in degrees. Positive values are east of the prime meridian, negative values are west of it.

Responses
200

Normal response.

401

Unauthorized response.

put/config/location
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/location

SecurityApiKey
Request
Request Body schema: application/json
latitude
number (configLocationLatitude)

The latitude of the meter's location in degrees. Positive values are north of the equator, negative values south of it.

longitude
number (configLocationLongitude)

The longitude of the meter's location in degrees. Positive values are east of the prime meridian, negative values are west of it.

Responses
200

Normal response.

401

Unauthorized response.

post/config/location
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/location

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/location
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}