Skip to content
Docs
Select language:English

/api/v1/meters/{id}/unit

POST
/api/v1/meters/{id}/unit
curl --request POST \
  --url https://example.com/api/v1/meters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/unit \
  --header 'Content-Type: application/json' \
  --data '{ "unit": "example", "convert": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
unit
required
string
>= 1 characters <= 12 characters
convert
required
boolean
Examplegenerated
{
  "unit": "example",
  "convert": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
meter
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
unit
required
string
label
required
string | null
latest
required
Any of:
object
value
required
string
takenAt
required
string
needsReview
required
number
maxPerDay
required
number | null
offset
required
string
rowVersion
required
number
nudgeDays
required
number | null
estimate
required
object
perDay
required
string | null
basisDays
required
number | null
ageDays
required
number | null
advice
required
string
Allowed values: none fresh stale unknown
changed
required
object
readings
required
number
replacements
required
number
schedules
required
number
undo
required
object
eventId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
until
required
string
Example
{
  "meter": {
    "estimate": {
      "advice": "none"
    }
  }
}