MealSquare API

Version: 1.0.0

http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Default

delete /meals/{id}
get /meals/{id}
post /meals/mealPlan
post /meals/filters
post /meals
post /meals/{id}/image
put /meals/{id}

Default

delete /meals/{id}

Delete the Meal with the given id (deleteMeal)

Path parameters

id (required)

Path Parameter —

Responses

200

400

BAD_REQUEST

401

UNAUTHORIZED

get /meals/{id}

Get the Meal with the given id (getMeal)

Path parameters

id (required)

Path Parameter —

Return type

ResponseMeal

Example data

Content-Type: application/json

{
  "image" : "",
  "carbBase" : "carbBase",
  "name" : "name",
  "ingredients" : {
    "amount" : "amount",
    "ingredientName" : "ingredientName"
  },
  "id" : "id",
  "time" : 0,
  "tags" : [ "tags", "tags" ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK ResponseMeal

400

BAD_REQUEST

401

UNAUTHORIZED

post /meals/mealPlan

Generate a Meal plan based on the given criteria (getMealPlan)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Filter (optional)

Body Parameter —

Query parameters

days (optional)

Query Parameter — format: int32

Return type

ArrayOfMeals

Example data

Content-Type: application/json

[ {
  "image" : "",
  "carbBase" : "carbBase",
  "name" : "name",
  "ingredients" : {
    "amount" : "amount",
    "ingredientName" : "ingredientName"
  },
  "id" : "id",
  "time" : 0,
  "tags" : [ "tags", "tags" ]
}, {
  "image" : "",
  "carbBase" : "carbBase",
  "name" : "name",
  "ingredients" : {
    "amount" : "amount",
    "ingredientName" : "ingredientName"
  },
  "id" : "id",
  "time" : 0,
  "tags" : [ "tags", "tags" ]
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

OK ArrayOfMeals

400

BAD_REQUEST

401

UNAUTHORIZED

post /meals/filters

Get meals based on the given filter (getMealsFiltered)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body Filter (required)

Body Parameter —

Return type

ArrayOfMeals

Example data

Content-Type: application/json

[ {
  "image" : "",
  "carbBase" : "carbBase",
  "name" : "name",
  "ingredients" : {
    "amount" : "amount",
    "ingredientName" : "ingredientName"
  },
  "id" : "id",
  "time" : 0,
  "tags" : [ "tags", "tags" ]
}, {
  "image" : "",
  "carbBase" : "carbBase",
  "name" : "name",
  "ingredients" : {
    "amount" : "amount",
    "ingredientName" : "ingredientName"
  },
  "id" : "id",
  "time" : 0,
  "tags" : [ "tags", "tags" ]
} ]