RXrxfoodapp
food

Get the food information from the server

Changed on
get/food

Request

  • Base URL
    https://api.rxfoodapp.com/api
  • URL
    https://api.rxfoodapp.com/api/food
  • Auth
    HTTP bearer

Query parameters

food_namestring
rxfood_idstring

Exact catalogue row. Prefer this when the caller already has an rxfood_id from search (shared names have multiple nutrition_source siblings).

nutrition_sourcestring

When resolving by food_name, only return a DBFood whose nutrition_source or primary_data_origin_code matches (e.g. cnf).

user_idnumber

Response

successful operation

adult_serving_size_gnumber nullable
base_namestring
brandstring
carbohydrate_gnumber
custom_item_sourcestring nullable

See documentation regarding these values in the "Engineering Loop -> Reference Documents -> Referencing Foods by Source and ID" page:

https://rxfood.sharepoint.com/:fl:/r/contentstorage/CSP_14a5252e-2526-4d18-8a2e-c2c70eba2ba3/Document%20Library/LoopAppData/Food%20ID%20and%20Nutrition%20Source%20fields.loop?d=w91a1be15daed463590155c82c9ef2034&csf=1&web=1&e=orgDCL&nav=cz0lMkZjb250ZW50c3RvcmFnZSUyRkNTUF8xNGE1MjUyZS0yNTI2LTRkMTgtOGEyZS1jMmM3MGViYTJiYTMmZD1iJTIxTGlXbEZDWWxHRTJLTHNMSERyb3JvOFlodG0wcEcwMUR1OVNOSTZ2RjhPLTJEVGktMXNmb1M0X29CQmpBWXZFbiZmPTAxVUxTRUVWQVZYMlFaRDNPMkdWREpBRks0UUxFNjZJQlUmYz0lMkYmYT1Mb29wQXBwJnA9JTQwZmx1aWR4JTJGbG9vcC1wYWdlLWNvbnRhaW5lciZ4PSU3QiUyMnclMjIlM0ElMjJUMFJUVUh4eWVHWnZiMlF1YzJoaGNtVndiMmx1ZEM1amIyMThZaUZNYVZkc1JrTlpiRWRGTWt0TWMweElSSEp2Y204NFdXaDBiVEJ3UnpBeFJIVTVVMDVKTm5aR09FOHRNa1JVYVMweGMyWnZVelJmYjBKQ2FrRlpka1Z1ZkRBeFZVeFRSVVZXUkVKYVR6UlRSa0pNUzFwT1EwbFBVbHBGVGxVelFsaE5XVEklM0QlMjIlMkMlMjJpJTIyJTNBJTIyYmE3ODVlMDQtMGQ4Yy00ZDAxLTgxZDYtMWYwYTUzYzBlNTViJTIyJTdE

Note: this field is currently only used by food_engine_food_response_to_food_response, although it may be used by other services in the future.

custom_item_source_idstring nullable

See documentation regarding these values in the "Engineering Loop -> Reference Documents -> Referencing Foods by Source and ID" page:

https://rxfood.sharepoint.com/:fl:/r/contentstorage/CSP_14a5252e-2526-4d18-8a2e-c2c70eba2ba3/Document%20Library/LoopAppData/Food%20ID%20and%20Nutrition%20Source%20fields.loop?d=w91a1be15daed463590155c82c9ef2034&csf=1&web=1&e=orgDCL&nav=cz0lMkZjb250ZW50c3RvcmFnZSUyRkNTUF8xNGE1MjUyZS0yNTI2LTRkMTgtOGEyZS1jMmM3MGViYTJiYTMmZD1iJTIxTGlXbEZDWWxHRTJLTHNMSERyb3JvOFlodG0wcEcwMUR1OVNOSTZ2RjhPLTJEVGktMXNmb1M0X29CQmpBWXZFbiZmPTAxVUxTRUVWQVZYMlFaRDNPMkdWREpBRks0UUxFNjZJQlUmYz0lMkYmYT1Mb29wQXBwJnA9JTQwZmx1aWR4JTJGbG9vcC1wYWdlLWNvbnRhaW5lciZ4PSU3QiUyMnclMjIlM0ElMjJUMFJUVUh4eWVHWnZiMlF1YzJoaGNtVndiMmx1ZEM1amIyMThZaUZNYVZkc1JrTlpiRWRGTWt0TWMweElSSEp2Y204NFdXaDBiVEJ3UnpBeFJIVTVVMDVKTm5aR09FOHRNa1JVYVMweGMyWnZVelJmYjBKQ2FrRlpka1Z1ZkRBeFZVeFRSVVZXUkVKYVR6UlRSa0pNUzFwT1EwbFBVbHBGVGxVelFsaE5XVEklM0QlMjIlMkMlMjJpJTIyJTNBJTIyYmE3ODVlMDQtMGQ4Yy00ZDAxLTgxZDYtMWYwYTUzYzBlNTViJTIyJTdE

Note: this field is currently only used by food_engine_food_response_to_food_response, although it may be used by other services in the future.

custom_tipstring nullable
descriptionstring nullable
energy_kcalnumber nullable
favoriteboolean

if this food is set favorite of the queried user

filter_tagsstring[] nullable
food_image_urlstring nullable required
ingredients_strstring nullable
level1string nullable
level2string nullable
level3string nullable
level4string nullable
namestring required
name_translationsobject nullable required
notestring nullable
nutrition_sourcestring
nutrition_source_idinteger
previously_loggedboolean

if this food is previously logged by the queried user

primary_data_origin_codestring nullable

Stable provenance code from food.primary_data_origin_code when the hit came from DBFood

protein_gnumber nullable
recipe_idinteger nullable
result_kind'food' | 'recipe'

Discriminator so a logging client can call from_recipe when the hit is a recipe.

rxfood_idstring nullable required
similar_itemsstring[]
statusstring

Example response

{
  "nutrient_overrides": {
    "aa_patient": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "bb_reviewer": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "cc_external": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "dd_estimate": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    },
    "ee_validation": {
      "ontology": {
        "id": 42,
        "levels": [
          "food"
        ]
      }
    }
  }
}

Changes

  • 5a99db4cbce3Revision changes
    • info

      added the new optional query request parameter nutrition_source

    • info

      added the new optional query request parameter rxfood_id

    • info

      the query request parameter food_name became optional

  • a229b18839a0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status