RXrxfoodapp
food

Get favorite food of the patient from the server

get/patients/{patient_id}/foods/favorites

Request

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

Path parameters

patient_idinteger required

Response

successful operation

addon_namesstring[] nullable
carbohydrate_gnumber
custom_labelstring nullable

user-defined label to identify the favorite.

favorite_idnumber required

id of the favorited item

food_namestring required

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

serving_unit_label_translationsobject nullable
servingsnumber nullable

number of servings to be stored

similar_itemsstring[]

Example response

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

Changes

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