GET api/CourseDeclarations?year={year}&week={week}&courseType={courseType}&courseId={courseId}&fullResult={fullResult}

Get Course Declaration

Request Information

URI Parameters

Name	Description	Type	Additional information
year	Year for Course Declaration (default: Current year)	integer	Default value is 0
week	Week for Course Declaration (default: Current week)	integer	Default value is 0
courseType	Course Type	CourseTypeEnum	Default value is MainCourse
courseId	Reference to specific Course	integer	Default value is 0
fullResult	Full result of connected entities	FullResultEnum	Default value is No

Body Parameters

None.

Response Information

Resource Description

Course Declaration object

CourseDeclarationDto

Name	Description	Type	Additional information
Year	Year - related to Menu Plan	integer	None.
Week	Week - related to Menu Plan	integer	None.
CourseId	Course Id (foreign key) for Courses	integer	None.
DietFormId	Id (foreign key) for Diet Form	integer	None.
DietForm	Diet Form Description	string	None.
Ingredient	Ingredient Description	string	None.
Allergen	Allergen Description	string	None.
EnergyKJ	kJ	decimal number	Required
EnergyKCAL	Kcal	decimal number	Required
Fat	Fat	decimal number	Required
FatSaturated	Fat, Saturated fatty acids (SAF)	decimal number	Required
Carbohydrate	Carbohydrate	decimal number	Required
CarbohydrateSugar	Carbohydrate, Sugar	decimal number	Required
Protein	Protein	decimal number	Required
Salt	Natriumchlorid (Salt)	decimal number	Required
Alcohol	Alcohol	decimal number	Required
HeartHealthy	Heart Healthy Course	boolean	Required
Fiber	Dietary fibers	decimal number	Required
NetWeight	Net Weight	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Year": 1,
  "Week": 2,
  "CourseId": 1,
  "DietFormId": 1,
  "DietForm": "sample string 3",
  "Ingredient": "sample string 4",
  "Allergen": "sample string 5",
  "EnergyKJ": 6.0,
  "EnergyKCAL": 7.0,
  "Fat": 8.0,
  "FatSaturated": 9.0,
  "Carbohydrate": 10.0,
  "CarbohydrateSugar": 11.0,
  "Protein": 12.0,
  "Salt": 13.0,
  "Alcohol": 14.0,
  "HeartHealthy": true,
  "Fiber": 16.0,
  "NetWeight": "sample string 17"
}