API ReferenceReadings Weight

Record Weight Reading

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

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
readingTimestampstringRequiredformat: "date-time"
The UTC timestamp at which the reading was taken.
weightdoubleRequired>=0
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.
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.
patientIdlongOptional
The id of the patient that took the reading.

Response

OK
readingTimestampstringformat: "date-time"
The UTC timestamp at which the reading was taken.
weightdouble>=0
The weight reading in lbs.
deviceobject or null
The device used to take the reading.
deviceTimeZoneOffsetinteger or null
The offset of the device's timezone from UTC in seconds. Null if unavailable.
idlong or null
Unique identifier for the reading.
itemobject or null
The item used to take the reading.
manualboolean or null
True if the reading value was entered manually, false or null otherwise.
patientobject or null
The patient who took the reading.
patientTimeZoneOffsetinteger or null
The offset of the patient's timezone from UTC in seconds. Null if unavailable.
weightUnitenum or null
Allowed values: