Readings - Weight

Record Weight Reading

POST

This endpoint records a weight reading based on the provided request. Either a device ID, device identifier, or patient ID is required.


For more information see the WeightReadingRequest Model.

Request

This endpoint expects an object.
readingTimestamp
datetimeRequired
The UTC timestamp at which the reading was taken.
weight
doubleRequired
The weight reading in lbs.
deviceId
integerOptional
The id of the device that took the reading.
deviceIdentifier
stringOptional
The device identifier of the device that took the reading.
patientId
integerOptional
The id of the patient that took the reading.
deviceTimeZoneOffset
integerOptional
The offset of the device's timezone from UTC in seconds. Null if unavailable.
manual
booleanOptional
True if the reading value was entered manually, false or null otherwise.

Response

This endpoint returns an object
readingTimestamp
string
The UTC timestamp at which the reading was taken.
weight
double
The weight reading in lbs.
id
integerOptional
Unique identifier for the reading.
manual
booleanOptional
True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset
integerOptional
The offset of the device's timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset
integerOptional
The offset of the patient's timezone from UTC in seconds. Null if unavailable.
patient
objectOptional
The patient who took the reading.
item
objectOptional
The item used to take the reading.
device
objectOptional
The device used to take the reading.