POST api/GetSiteOrderGroup

Request Information

URI Parameters

None.

Body Parameters

SiteOrderGroupRequestModel
NameDescriptionTypeAdditional information
SchoolId

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "SchoolId": "44c0323c-4f7e-41c2-8bf1-17a849268916"
}

application/xml, text/xml

Sample: 
<SiteOrderGroupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <SchoolId>44c0323c-4f7e-41c2-8bf1-17a849268916</SchoolId>
</SiteOrderGroupRequestModel>

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

Response Information

Resource Description

Collection of SiteOrderGroupResponseModel
NameDescriptionTypeAdditional information
OrderGroupId

integer

None.
OrderGroupName

string

None.
OrderGroupDescription

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "OrderGroupId": 1,
    "OrderGroupName": "sample string 2",
    "OrderGroupDescription": "sample string 3"
  },
  {
    "OrderGroupId": 1,
    "OrderGroupName": "sample string 2",
    "OrderGroupDescription": "sample string 3"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfSiteOrderGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.Primero.OnlineFRE.APIs.Models.Order">
  <SiteOrderGroupResponseModel>
    <OrderGroupDescription>sample string 3</OrderGroupDescription>
    <OrderGroupId>1</OrderGroupId>
    <OrderGroupName>sample string 2</OrderGroupName>
  </SiteOrderGroupResponseModel>
  <SiteOrderGroupResponseModel>
    <OrderGroupDescription>sample string 3</OrderGroupDescription>
    <OrderGroupId>1</OrderGroupId>
    <OrderGroupName>sample string 2</OrderGroupName>
  </SiteOrderGroupResponseModel>
</ArrayOfSiteOrderGroupResponseModel>