exercise_entries.get

Description

Returns the daily exercise entries for the user on a nominated date.

The API will always return 24 hours worth of exercise entries for a given user on a given date. These entries will either be "template" entries (which a user may override for any given day of the week) or saved exercise entry values.

Once a user saves or updates the entries on any given day, all entries for that day are saved. All adjustments to the day involve reducing the time for an existing activity in order to either add or increase the time taken for another activity. The default entries presented for a user for a given day of the week can be overridden using exercise_entries.save_template.

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 "exercise_entries.get"
oauth_token String The key of the profile to use.

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

Response

The exercise entries returned contain the time undertaken and energy consumed for each activity for a user on the nominate date as follows:

  • exercise_id – the unique exercise identifier.
  • exercise_name – the name of the exercise - where the exercise_id is '0' this is a user entered description.
  • minutes is an Int – the duration of the activity in minutes (for a total of 1440 minutes/day).
  • calories is an Decimal – the estimated energy consumed per activity in kcal, based on the user's weight – where the exercise_id is '0' this is a user entered value.

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>
<exercise_entries 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">
    <exercise_entry>
        <is_template_value>0</is_template_value>
        <exercise_id>2</exercise_id>
        <exercise_name>Resting</exercise_name>
        <minutes>960</minutes>
        <calories>1349</calories>
    </exercise_entry>
    <exercise_entry>
        <is_template_value>0</is_template_value>
        <exercise_id>1</exercise_id>
        <exercise_name>Sleeping</exercise_name>
        <minutes>480</minutes>
        <calories>607</calories>
    </exercise_entry>
</exercise_entries>

Example Return JSON

{ "exercise_entries": { "exercise_entry": [ {"calories": "1349", "exercise_id": "2", "exercise_name": "Resting", "is_template_value": "0", "minutes": "960" }, {"calories": "607", "exercise_id": "1", "exercise_name": "Sleeping", "is_template_value": "0", "minutes": "480" } ] }}

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>"
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Support
API

About FatSecret

© 2021 FatSecret. All rights reserved.