RXrxfoodapp
recipes

Resolve, correct or reject one ingredient line

Changed on

Attach a food to the line, replace an incorrect match, or reject the line as not an ingredient. Every outcome is written to the correction ledger with actor_type patient, and the recipe's nutrition is recalculated.

put/patients/{patient_id}/recipes/{recipe_id}/review/{ingredient_id}

Request

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

Path parameters

patient_idinteger required
recipe_idinteger required
ingredient_idinteger required

Request body

group_idinteger nullable

Move the line into this existing ingredient group on the recipe. Omit to leave its group unchanged.

group_namestring nullable

Move the line into a group with this name, creating it on the recipe if needed. An empty string ungroups the line. Takes precedence over group_id.

rejectedboolean

The line is not an ingredient; it is removed and the decision recorded.

rxfood_idstring nullable

CNF food to attach. Required unless rejected.

serving_unit_amountnumber nullable
serving_unit_labelstring nullable
servingsnumber nullable

Response

successful operation

child_recipe_idinteger nullable
descriptionstring nullable
extracted_namestring nullable

What the parser read the ingredient as.

food_namestring nullable
group_idinteger nullable

Ingredient group this line belongs to, or null when ungrouped.

group_namestring nullable

Display name of the line's ingredient group, for showing headings without a second lookup.

ingredient_idinteger nullable

Null for a rejected line, which no longer has an ingredient but stays visible so the curator can see what was discarded.

mapping_confidencenumber nullable
mapping_status'unmatched' | 'auto' | 'confirmed' | 'rejected' nullable

A rejected line is returned with resolved=true and no ingredient_id: it needs no further decision but is shown so the discard is visible.

original_textstring nullable

What the source said, for a scanned or imported line.

resolvedboolean
rxfood_idstring nullable
serving_unit_labelstring nullable
servingsnumber nullable
sort_orderinteger

Changes