fatsecret Platform API Documentation
Description
Deletes the specified food entry for the user.
Parameters
URL / Method
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
URL (new) Method |
N/A | Required | "https://platform.fatsecret.com/rest/food-entries/v1" HTTP "DELETE" |
OR | |||
method | String | Required | "food_entry.delete" (included with other parameters) |
Additional Parameters
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
food_entry_id | Long | Required | Unique identifier of the food diary entry |
format | String | Optional | The desired response format. Valid response formats are "xml" or "json" (default value is "xml"). |
URL Based Integration
As part of a transition away from parameterized methods as actions, we have introduced a URL based structure with a relative HTTP Method (GET, POST, PUT, DELETE)
You may continue to use method based calls however we recommend updating to path based calls for new integrations.
Please refer to our guide here for additional information
Response
There are no storable values returned by this call.
Each success
element contains information as follows:
NAME | TYPE | DESCRIPTION |
---|---|---|
success | Int | Whether the call succeeded or not. If successful equals 1 |
Example Response
Example 1:
<?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 1:
{
"success": {
"value": "1"
}
}
Error Codes
CODE | TYPE | DESCRIPTION |
---|---|---|
2 | OAuth 1.0 | Missing required oauth parameter: '<details>' |
3 | OAuth 1.0 | Unsupported oauth parameter: '<details>' |
4 | OAuth 1.0 | Invalid signature method: '<details>' |
5 | OAuth 1.0 | Invalid consumer key: '<details>' |
6 | OAuth 1.0 | Invalid/expired timestamp: '<details>' |
7 | OAuth 1.0 | Invalid/used nonce: '<details>' |
8 | OAuth 1.0 | Invalid signature: '<details>' |
9 | OAuth 1.0 | Invalid access token: '<details>' |
101 | Parameter | Missing required parameter: '<details>' |