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.
readingTimestampdatetimeRequired

The UTC timestamp at which the reading was taken.

weightdoubleRequired

The weight reading value in lbs.

deviceIdlongOptional

The id of the device that took the reading.

deviceIdentifierstringOptional

The device identifier of the device that took the reading.

patientIdlongOptional

The id of the patient that took the reading.

deviceTimeZoneOffsetintegerOptional

The offset of the device’s timezone from UTC in seconds. Null if unavailable.

manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

Response

This endpoint returns an object.
readingTimestampdatetime

The UTC timestamp at which the reading was taken.

weightdouble

The weight reading in lbs.

idlongOptional

Unique identifier for the reading.

manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

deviceTimeZoneOffsetintegerOptional

The offset of the device’s timezone from UTC in seconds. Null if unavailable.

patientTimeZoneOffsetintegerOptional

The offset of the patient’s timezone from UTC in seconds. Null if unavailable.

patientobjectOptional

The patient who took the reading.

itemobjectOptional

The item used to take the reading.

deviceobjectOptional

The device used to take the reading.

weightUnit"lbs"Optional
Allowed values: lbs