POST api/GetServingZonesForFulfillment

Request Information

URI Parameters

None.

Body Parameters

ServingZonesRequestModel
NameDescriptionTypeAdditional information
SchoolId

globally unique identifier

None.

RegionId

integer

None.

MealTypeId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SchoolId": "8a4ae380-63f7-4808-aee7-fac514f48449",
  "RegionId": 1,
  "MealTypeId": 2
}

application/xml, text/xml

Sample:
<ServingZonesRequestModel 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>1</RegionId>
  <SchoolId>8a4ae380-63f7-4808-aee7-fac514f48449</SchoolId>
</ServingZonesRequestModel>

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 'ServingZonesRequestModel'.

Response Information

Resource Description

Collection of ServingZonesResponseModel
NameDescriptionTypeAdditional information
ServingZoneId

integer

None.

ServingZoneName

string

None.

ServingZoneDescription

string

None.

IsActive

boolean

None.

FullService

boolean

None.

PickUp

boolean

None.

SchoolId

globally unique identifier

None.

RegionId

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ServingZoneId": 1,
    "ServingZoneName": "sample string 2",
    "ServingZoneDescription": "sample string 3",
    "IsActive": true,
    "FullService": true,
    "PickUp": true,
    "SchoolId": "ee0d16d1-d75d-4bf0-a9a6-4cfd1881d01c",
    "RegionId": 8
  },
  {
    "ServingZoneId": 1,
    "ServingZoneName": "sample string 2",
    "ServingZoneDescription": "sample string 3",
    "IsActive": true,
    "FullService": true,
    "PickUp": true,
    "SchoolId": "ee0d16d1-d75d-4bf0-a9a6-4cfd1881d01c",
    "RegionId": 8
  }
]

application/xml, text/xml

Sample:
<ArrayOfServingZonesResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <ServingZonesResponseModel>
    <FullService>true</FullService>
    <IsActive>true</IsActive>
    <PickUp>true</PickUp>
    <RegionId>8</RegionId>
    <SchoolId>ee0d16d1-d75d-4bf0-a9a6-4cfd1881d01c</SchoolId>
    <ServingZoneDescription>sample string 3</ServingZoneDescription>
    <ServingZoneId>1</ServingZoneId>
    <ServingZoneName>sample string 2</ServingZoneName>
  </ServingZonesResponseModel>
  <ServingZonesResponseModel>
    <FullService>true</FullService>
    <IsActive>true</IsActive>
    <PickUp>true</PickUp>
    <RegionId>8</RegionId>
    <SchoolId>ee0d16d1-d75d-4bf0-a9a6-4cfd1881d01c</SchoolId>
    <ServingZoneDescription>sample string 3</ServingZoneDescription>
    <ServingZoneId>1</ServingZoneId>
    <ServingZoneName>sample string 2</ServingZoneName>
  </ServingZonesResponseModel>
</ArrayOfServingZonesResponseModel>