POST api/GetServingPeriods

Request Information

URI Parameters

None.

Body Parameters

ServingPeriodsRequestModel
NameDescriptionTypeAdditional information
SchoolId

globally unique identifier

None.
MealTypeId

integer

None.
RegionId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "SchoolId": "bafcc71d-65c1-42bc-b3bf-0e6022ac6f01",
  "MealTypeId": 2,
  "RegionId": 3
}

application/xml, text/xml

Sample: 
<ServingPeriodsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <MealTypeId>2</MealTypeId>
  <RegionId>3</RegionId>
  <SchoolId>bafcc71d-65c1-42bc-b3bf-0e6022ac6f01</SchoolId>
</ServingPeriodsRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ServingPeriodsRequestModel'.

Response Information

Resource Description

Collection of ServingPeriodsResponseModel
NameDescriptionTypeAdditional information
ServingPeriodId

integer

None.
ServingPeriodName

string

None.
MealTypeId

integer

None.
StartTime

date

None.
EndTime

date

None.
DayCheck

boolean

None.
SchoolId

globally unique identifier

None.
RegionId

integer

None.
IsActive

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ServingPeriodId": 1,
    "ServingPeriodName": "sample string 2",
    "MealTypeId": 3,
    "StartTime": "2025-12-06T03:50:35.2448744+00:00",
    "EndTime": "2025-12-06T03:50:35.2448744+00:00",
    "DayCheck": true,
    "SchoolId": "5e908d94-76b5-4281-bcc8-74ef97115228",
    "RegionId": 8,
    "IsActive": true
  },
  {
    "ServingPeriodId": 1,
    "ServingPeriodName": "sample string 2",
    "MealTypeId": 3,
    "StartTime": "2025-12-06T03:50:35.2448744+00:00",
    "EndTime": "2025-12-06T03:50:35.2448744+00:00",
    "DayCheck": true,
    "SchoolId": "5e908d94-76b5-4281-bcc8-74ef97115228",
    "RegionId": 8,
    "IsActive": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfServingPeriodsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <ServingPeriodsResponseModel>
    <DayCheck>true</DayCheck>
    <EndTime>2025-12-06T03:50:35.2448744+00:00</EndTime>
    <IsActive>true</IsActive>
    <MealTypeId>3</MealTypeId>
    <RegionId>8</RegionId>
    <SchoolId>5e908d94-76b5-4281-bcc8-74ef97115228</SchoolId>
    <ServingPeriodId>1</ServingPeriodId>
    <ServingPeriodName>sample string 2</ServingPeriodName>
    <StartTime>2025-12-06T03:50:35.2448744+00:00</StartTime>
  </ServingPeriodsResponseModel>
  <ServingPeriodsResponseModel>
    <DayCheck>true</DayCheck>
    <EndTime>2025-12-06T03:50:35.2448744+00:00</EndTime>
    <IsActive>true</IsActive>
    <MealTypeId>3</MealTypeId>
    <RegionId>8</RegionId>
    <SchoolId>5e908d94-76b5-4281-bcc8-74ef97115228</SchoolId>
    <ServingPeriodId>1</ServingPeriodId>
    <ServingPeriodName>sample string 2</ServingPeriodName>
    <StartTime>2025-12-06T03:50:35.2448744+00:00</StartTime>
  </ServingPeriodsResponseModel>
</ArrayOfServingPeriodsResponseModel>