GET api/Courses/{id}?fullResult={fullResult}&courseType={courseType}

Get Course by Id / Type

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id (key) of Course	integer	Required
fullResult	Full result of connected entities	FullResultEnum	Default value is Yes
courseType	Course Type	CourseTypeEnum	Default value is MainCourse

Body Parameters

None.

Response Information

Resource Description

Course object by id

CourseDto

Name	Description	Type	Additional information
CourseType	Course Type - 1: MainCourse, 2: StarterDessert	integer	Required
Type	Course Type Entity	CourseTypeDto	None.
CourseId	CourseId (key) of Course	integer	Required
Course	Course Description	string	Required
CourseFormatted	Course Description, Formatted	string	None.
SalesUnitId	SalesUnit Id (foreign key) for Salesunits	integer	Required
SalesUnit	SalesUnit Entity	SalesUnitDto	None.
SalesUnitContains	SalesUnit Contains (Amount)	decimal number	Required
ProductTypes	Collection of Product Types	Collection of CourseProductTypeDto	None.
Preferences	Collection of Preference Types	Collection of CoursePreferenceTypeDto	None.

Response Formats

application/json, text/json

Sample:

{
  "CourseType": 1,
  "Type": {
    "CourseTypeId": 1,
    "Description": "sample string 2"
  },
  "CourseId": 2,
  "Course": "sample string 3",
  "CourseFormatted": "sample string 4",
  "SalesUnitId": 5,
  "SalesUnit": {
    "SalesUnitId": 1,
    "Name": "sample string 2",
    "SortOrder": 3
  },
  "SalesUnitContains": 6.0,
  "ProductTypes": [
    {
      "ProductTypeId": 1,
      "Description": "sample string 2",
      "ProductType": {
        "ProductTypeId": 1,
        "Description": "sample string 2",
        "FilterIngrediens": true,
        "FilterRecipes": true,
        "FilterCourses": true,
        "SortOrder": 1
      }
    },
    {
      "ProductTypeId": 1,
      "Description": "sample string 2",
      "ProductType": {
        "ProductTypeId": 1,
        "Description": "sample string 2",
        "FilterIngrediens": true,
        "FilterRecipes": true,
        "FilterCourses": true,
        "SortOrder": 1
      }
    }
  ],
  "Preferences": [
    {
      "PreferenceTypeId": 1,
      "Description": "sample string 2",
      "PreferenceType": {
        "PreferenceTypeId": 1,
        "Description": "sample string 2"
      }
    },
    {
      "PreferenceTypeId": 1,
      "Description": "sample string 2",
      "PreferenceType": {
        "PreferenceTypeId": 1,
        "Description": "sample string 2"
      }
    }
  ]
}