LCAFDB API documentation

GET /api/categories.{_format}

Return a collection of Category

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
search	string	false		Search key.
limit	integer	false		Limit the result.

Status Codes

Status Code	Description
200	Returned when at least one Category found.
404	Returned when no Category found.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/categories/{id}.{_format}

Return a Category entity

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when the requested Category are found.
404	Returned when no Category found.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/func/calculate.{_format}

Calculate the carbon footprint of an Ingredient.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
ingredient	integer	true	\d+	The Ingredient id.
amount	float	true	[0-9]*(\.[0-9]+)?	The amount of the selected unit.
unit	string	true	centiliter \| cl \| deciliter \| dl \| dessertsked \| dsk \| kryddmått \| krm \| liter \| l \| milliliter \| ml \| matsked \| msk\| tesked \| tsk \| gram \| g \| hektogram \| hg \| milligram \| mg \| kilo \| kg	The unit for the selected amount.

Status Codes

Status Code	Description
200	Returned when calculation was executed.
400	Returned when some parameters are missing.
404	Returned when no Ingredient found.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/ingredients.{_format}

Return a collection of Ingredient

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format	xml\|json

Parameters

Parameter	Type	Required?	Format	Description
search	string	false		Search key.
limit	integer	false		Limit the result.

Status Codes

Status Code	Description
200	Returned when at least one Ingredient found.
404	Returned when no Ingredient found.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/ingredients/{id}.{_format}

Return a Ingredient entity

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id	\d+
_format	xml\|json

Status Codes

Status Code	Description
200	Returned when the requested Ingredient are found.
404	Returned when no Ingredient found.

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/synonyms.{_format}

Create a Synonym to a Ingredient

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Parameters

Parameter	Type	Required?	Format	Description
ingredient	integer	true	\d+	The Ingredient id the Synonym relates to.
name	string	true		The Synonym name.

Status Codes

Status Code	Description
201	Synonym enity creation succesful.
204	A Ingredient or Synonym with requested name alreade exists.
400	Validation failed. Parameters missing.

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set