RXrxfoodapp
food

Set favorite food of the patient

put/patients/{patient_id}/foods/favorite

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/patients/{patient_id}/foods/favorite
  • Auth
    HTTP bearer

Path parameters

patient_idinteger required

Query parameters

food_namestring

Request body

addon_namesstring[] nullable
custom_labelstring nullable

user-defined label to be stored with the favorite.

favorite_idnumber

primary key of the favorite items

food_namestring

food name

notestring nullable

note to be stored with the favorite.

replacement_food_namestring nullable

replacement food as generated by the system

serving_type_labelstring nullable

special label indicating custom servings, such pizza size

serving_type_multipliernumber nullable

multiplier applied to a serving to account for sizing, such as a large pizza when the reference is a small pizza

serving_unit_amountnumber nullable

unit amount in grams per serving

serving_unit_labelstring nullable

unit of measure coinciding with the unit amount

servingsnumber nullable

number of servings to be stored

Example request

{
  "food_name": "pizza",
  "replacement_food_name": "thin crust pizza"
}

Response

successful operation

Changes

No recorded changes to this operation across all 19 revisions of this API.