POST api/GetPickUpWindowsBySchoolId

Request Information

URI Parameters

None.

Body Parameters

PickUpWindowBySchoolRequestModel
NameDescriptionTypeAdditional information
SchoolId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "SchoolId": "dd25cf5e-ae99-4079-824b-ab1e7600b8d6"
}

application/xml, text/xml

Sample: 
<PickUpWindowBySchoolRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.Business.ORD">
  <SchoolId>dd25cf5e-ae99-4079-824b-ab1e7600b8d6</SchoolId>
</PickUpWindowBySchoolRequestModel>

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

Response Information

Resource Description

Collection of OrdPickUpSite
NameDescriptionTypeAdditional information
ServingSchoolId

globally unique identifier

None.
ServingSchoolName

string

None.
PickUpWindows

Collection of OrdPickUpWindow

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ServingSchoolId": "33723d42-9476-4f0f-8c9c-bb43644a7d17",
    "ServingSchoolName": "sample string 2",
    "PickUpWindows": [
      {
        "OrdPickUpWindowId": 1,
        "PickUpWindowName": "sample string 2",
        "PickUpSpecialInstructions": "sample string 3",
        "IsActive": true,
        "OrdAvailabilityTypeId": 5,
        "OrdAvailabilityType": "sample string 6",
        "PrimeroSchoolId": "84fa38bb-f579-499a-ae6f-1fd42aff9d98",
        "dtOrdPickUpAdditionalSites": null,
        "dtOrdPickUpWeekDayDtls": []
      },
      {
        "OrdPickUpWindowId": 1,
        "PickUpWindowName": "sample string 2",
        "PickUpSpecialInstructions": "sample string 3",
        "IsActive": true,
        "OrdAvailabilityTypeId": 5,
        "OrdAvailabilityType": "sample string 6",
        "PrimeroSchoolId": "84fa38bb-f579-499a-ae6f-1fd42aff9d98",
        "dtOrdPickUpAdditionalSites": null,
        "dtOrdPickUpWeekDayDtls": []
      }
    ]
  },
  {
    "ServingSchoolId": "33723d42-9476-4f0f-8c9c-bb43644a7d17",
    "ServingSchoolName": "sample string 2",
    "PickUpWindows": [
      {
        "OrdPickUpWindowId": 1,
        "PickUpWindowName": "sample string 2",
        "PickUpSpecialInstructions": "sample string 3",
        "IsActive": true,
        "OrdAvailabilityTypeId": 5,
        "OrdAvailabilityType": "sample string 6",
        "PrimeroSchoolId": "84fa38bb-f579-499a-ae6f-1fd42aff9d98",
        "dtOrdPickUpAdditionalSites": null,
        "dtOrdPickUpWeekDayDtls": []
      },
      {
        "OrdPickUpWindowId": 1,
        "PickUpWindowName": "sample string 2",
        "PickUpSpecialInstructions": "sample string 3",
        "IsActive": true,
        "OrdAvailabilityTypeId": 5,
        "OrdAvailabilityType": "sample string 6",
        "PrimeroSchoolId": "84fa38bb-f579-499a-ae6f-1fd42aff9d98",
        "dtOrdPickUpAdditionalSites": null,
        "dtOrdPickUpWeekDayDtls": []
      }
    ]
  }
]

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot serialize the DataTable. DataTable name is not set.