RXrxfoodapp
goal

Create a new goal of the patient

Changed on
post/patients/{patient_id}/goals

Request

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

Path parameters

patient_idinteger required

Request body

change'increase' | 'decrease' required
goal_type'nutrient' | 'frequency' required
meal_slotsstring[] nullable

When period is meal, optional subset of meal names; default breakfast/lunch/dinner

period'day' | 'week' | 'breakfast' | 'lunch' | 'dinner' | 'snack' | 'meal' required
target_namestring required
target_range_highnumber nullable
target_range_lownumber nullable
target_range_type'above' | 'below' | 'within' nullable
target_valuenumber required

Example request

{
  "target_name": "vitamin_c_mg"
}

Response

successful operation

changestring required
current_valuenumber required
goal_image_urlstring nullable
goal_typestring required
idinteger required
meal_slotsstring[] nullable
patient_idinteger required
period'day' | 'week' | 'breakfast' | 'lunch' | 'dinner' | 'snack' | 'meal' required
statementstring required
target_display_namestring required
target_namestring required
target_range_highnumber nullable
target_range_lownumber nullable
target_range_type'above' | 'below' | 'within' nullable
target_unitstring nullable
target_valuenumber required

Changes

  • 7d063ed4f8caRevision 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