weight.update

Description

Records a user's weight for a nominated date.

First time weigh-ins require the goal_weight_kg and current_height_cm parameters.

Please note as per the API Terms of Use that it is your responsibility to ensure that the information generated by using the API is not be interpreted as a substitute for medical physician consultation, evaluation, or treatment.

Parameters

Required

Name Type Description
oauth_consumer_key String Your API key when you registered as a developer
oauth_signature_method String The method used to generate the signature (only HMAC-SHA1 is supported)
oauth_timestamp Int The date and time, expressed in the number of seconds since January 1, 1970 00:00:00 GMT. The timestamp value must be a positive integer and must be equal or greater than the timestamp used in previous requests
oauth_nonce String A randomly generated string for a request that can be combined with the timestamp to produce a unique value
oauth_version String MUST be "1.0"
oauth_signature String The signature, a consistent reproducible concatenation of the request elements into a single string. The string is used as an input in hashing or signing algorithms.
method String MUST be "weight.update"
oauth_token String The key of the profile to use.
current_weight_kg Decimal The current weight of the user in kilograms.

Optional

Name Type Description
format String The desired response format. Valid reponse formats are "xml" or "json" (default value is "xml").
date Int The number of days since January 1, 1970 (default value is the current day).
weight_type String The weight measurement type for this user profile. Valid types are "kg" and "lb" (default value is "kg").
height_type String The height measurement type for this user profile. Valid types are "cm" and "inch" (default value is "cm").
goal_weight_kg Decimal The goal weight of the user in kilograms. This is required for the first weigh-in.
current_height_cm Decimal The current height of the user in centimetres. This is required for the first weigh-in. You can only set this for the first time (subsequent updates will not change a user's height)
comment String A comment for this weigh-in.

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>
<success xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">1</success>

Example Return JSON

{ "success": {"value": "1" }}

Error Code

Code Description
2 Missing required oauth parameter: "<detail>"
3 Unsupported oauth parameter: "<detail>"
4 Invalid signature method: "<detail>"
5 Invalid consumer key: "<detail>"
6 Invalid/expired timestamp: "<detail>"
7 Invalid/used nonce: "<detail>"
8 Invalid signature: "<detail>"
9 Invalid access token: "<detail>"
101 Missing required parameter: "<detail>"
108 Invalid Type: "<detail>"
205 Date must be within 2 days from today: "<detail>"
206 Cannot update weight for an earlier date: "<detail>"
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Support
API

About FatSecret

© 2022 FatSecret. All rights reserved.