POST api/v{version}/Configuration/ContactDistrict

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

ContactDistrictModel

Name	Type	Additional information
Email	string	None.
DistrictId	integer	None.
DistrictDescription	string	None.
Phone	string	None.
DistrictContactNumber	string	None.
Name	string	None.
Comments	string	None.
isLunchMessage	boolean	None.
DisplayQuestion	boolean	None.
DisplayStudents	boolean	None.
DisplayDistrict	boolean	None.
SchoolsList	Collection of Schools	None.
IsContactLunch	IsContactLunchEnum	None.

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "DistrictId": 2,
  "DistrictDescription": "sample string 3",
  "Phone": "sample string 4",
  "DistrictContactNumber": "sample string 5",
  "Name": "sample string 6",
  "Comments": "sample string 7",
  "isLunchMessage": true,
  "DisplayQuestion": true,
  "DisplayStudents": true,
  "DisplayDistrict": true,
  "SchoolsList": [
    {
      "SiteId": "sample string 1",
      "SiteName": "sample string 2"
    },
    {
      "SiteId": "sample string 1",
      "SiteName": "sample string 2"
    }
  ],
  "IsContactLunch": 0
}

application/xml, text/xml

Sample:

<ContactDistrictModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.APIModels">
  <Comments>sample string 7</Comments>
  <DisplayDistrict>true</DisplayDistrict>
  <DisplayQuestion>true</DisplayQuestion>
  <DisplayStudents>true</DisplayStudents>
  <DistrictContactNumber>sample string 5</DistrictContactNumber>
  <DistrictDescription>sample string 3</DistrictDescription>
  <DistrictId>2</DistrictId>
  <Email>sample string 1</Email>
  <IsContactLunch>Blank</IsContactLunch>
  <Name>sample string 6</Name>
  <Phone>sample string 4</Phone>
  <SchoolsList>
    <Schools>
      <SiteId>sample string 1</SiteId>
      <SiteName>sample string 2</SiteName>
    </Schools>
    <Schools>
      <SiteId>sample string 1</SiteId>
      <SiteName>sample string 2</SiteName>
    </Schools>
  </SchoolsList>
  <isLunchMessage>true</isLunchMessage>
</ContactDistrictModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OperationResult

Name	Description	Type	Additional information
result		string	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1"
}

application/xml, text/xml

Sample:

<OperationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models">
  <Result>sample string 1</Result>
</OperationResult>