GET api/Sites/{SiteId}

Returns a Site.

Request Information

URI Parameters

Name	Description	Type	Additional information
SiteId	Application identifier for the Site	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Site object for the specified SiteId

Site

Name	Description	Type	Additional information
SchoolYear	The School Year for the Site.	integer	None.
SiteUid	The user identifier for the Site.	string	None.
StatePrId	The StatePrId for the Site.	string	None.
Name	The name for the Site.	string	None.
Url	The url for the Site's website.	string	None.
BeginGradeUid	The begin Grade user identifier for the Site.	string	None.
EndGradeUid	The end Grade user identifier for the Site.	string	None.
LunchMinutes	The number of lunch minutes for the Site.	integer	None.
LastDayOfFirstQuarter	The date of the last day of the first quarter for the Site.	date	None.
GraduationDate	The graduation date for the Site.	date	None.
ContactPerson	The office contact for the Site.	Person	None.
ContactAddress	The office address for the Site.	Address	None.
ContactPhone	The office phone for the Site.	Phone	None.
ContactEmail	The office email for the Site.	Email	None.
SchoolType	The School Type for the Site.	string	None.
SessionType	The Session Type for the Site.	string	None.
Title1Status	The Title 1 status for the Site. Values: NA, Targeted, SchoolWide	string	None.
OperationalStatus	The Operational Status for the Site.	string	None.
ProvisionStatus	The Provision status for the Site.	string	None.
AllowTeacherOverrideAttendance	The indicator for whether teachers are allowed to override Attendance in the Site.	boolean	None.
AllowTeacherOverrideEligibility	The indicator for whether teachers are allowed to override Eligibility in the Site.	boolean	None.
AllowTeacherOverrideEvalMark	The indicator for whether teachers are allowed to override Evaluation Marks in the Site.	boolean	None.
CalendarSummarySIFRefId	The CalendarSummarySIFRefID for the Site.	globally unique identifier	None.
SIFReported	The SIF Reported indicator for the Site.	boolean	None.
Grades	The grades for the Site.	Collection of Grade	None.
NCESID	The NCESID for the Site.	string	None.
PrincipalPerson	The principal for the Site.	Person	None.
PrincipalPhone	The principal's phone for the Site.	Phone	None.
PrincipalEmail	The principal's email for the Site.	Email	None.
Id	The application identifier for the object. This cannot be changed by the user.	globally unique identifier	None.
DataVersion	The version of the API data	string	None.
ApiName	The name of the object without the Api suffix	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SchoolYear": 1,
  "SiteUid": "sample string 2",
  "StatePrId": "sample string 3",
  "Name": "sample string 4",
  "Url": "sample string 5",
  "BeginGradeUid": "sample string 6",
  "EndGradeUid": "sample string 7",
  "LunchMinutes": 8,
  "LastDayOfFirstQuarter": "2025-04-26T00:08:33.1779283-05:00",
  "GraduationDate": "2025-04-26T00:08:33.1779283-05:00",
  "ContactPerson": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "AlternateFirstName": "sample string 6",
    "AlternateLastName": "sample string 7",
    "SSN": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "2025-04-26T00:08:33.1779283-05:00",
    "HispanicLatino": true,
    "AmericanIndian": true,
    "White": true,
    "Asian": true,
    "PacificIslander": true,
    "Black": true,
    "UnknownRace": true,
    "EmployerName": "sample string 18",
    "LanguageCodeUid": "sample string 19",
    "LanguageCodeDescription": "sample string 20",
    "Id": "58de50b2-f7df-4370-961a-6238a521c09b",
    "DataVersion": "sample string 22",
    "ApiName": ""
  },
  "ContactAddress": {
    "AddressType": "sample string 1",
    "AddressTypeDescription": "sample string 2",
    "Line1": "sample string 3",
    "Line2": "sample string 4",
    "Line3": "sample string 5",
    "Apartment": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Country": "sample string 9",
    "PostalCode": "sample string 10",
    "Zip": "sample string 11",
    "ZipPlusFour": "sample string 12",
    "RoomNumber": "sample string 13",
    "Id": "a1650fa8-6062-4781-86fc-8c52509cd2cc",
    "DataVersion": "sample string 15",
    "ApiName": ""
  },
  "ContactPhone": {
    "MessageDeviceType": "sample string 1",
    "MessageDeviceTypeDescription": "sample string 2",
    "Number": "sample string 3",
    "Description": "sample string 4",
    "Id": "7e7f4b64-d856-4952-b6f4-fff3efbc4581",
    "DataVersion": "sample string 6",
    "ApiName": ""
  },
  "ContactEmail": {
    "Address": "sample string 1",
    "Description": "sample string 2",
    "Id": "7d6a4231-f94e-447a-80e6-5848ec0faf87",
    "DataVersion": "sample string 4",
    "ApiName": ""
  },
  "SchoolType": "sample string 11",
  "SessionType": "sample string 12",
  "Title1Status": "sample string 13",
  "OperationalStatus": "sample string 14",
  "ProvisionStatus": "sample string 15",
  "AllowTeacherOverrideAttendance": true,
  "AllowTeacherOverrideEligibility": true,
  "AllowTeacherOverrideEvalMark": true,
  "CalendarSummarySIFRefId": "484d51ec-cac4-4c94-9246-6f69e23ff89a",
  "SIFReported": true,
  "Grades": [
    {
      "UID": "sample string 1",
      "Description": "sample string 2",
      "YearsTilGraduation": 3,
      "NextGradeId": "d38710f4-5b96-4631-9157-25c23d8a2478",
      "GradeOrder": 5,
      "Id": "be970970-f9e1-42af-9f84-ff2f4cd0bdd7",
      "DataVersion": "sample string 7",
      "ApiName": ""
    },
    {
      "UID": "sample string 1",
      "Description": "sample string 2",
      "YearsTilGraduation": 3,
      "NextGradeId": "d38710f4-5b96-4631-9157-25c23d8a2478",
      "GradeOrder": 5,
      "Id": "be970970-f9e1-42af-9f84-ff2f4cd0bdd7",
      "DataVersion": "sample string 7",
      "ApiName": ""
    }
  ],
  "NCESID": "sample string 21",
  "PrincipalPerson": {
    "Title": "sample string 1",
    "FirstName": "sample string 2",
    "MiddleName": "sample string 3",
    "LastName": "sample string 4",
    "Suffix": "sample string 5",
    "AlternateFirstName": "sample string 6",
    "AlternateLastName": "sample string 7",
    "SSN": "sample string 8",
    "Gender": "sample string 9",
    "BirthDate": "2025-04-26T00:08:33.1779283-05:00",
    "HispanicLatino": true,
    "AmericanIndian": true,
    "White": true,
    "Asian": true,
    "PacificIslander": true,
    "Black": true,
    "UnknownRace": true,
    "EmployerName": "sample string 18",
    "LanguageCodeUid": "sample string 19",
    "LanguageCodeDescription": "sample string 20",
    "Id": "58de50b2-f7df-4370-961a-6238a521c09b",
    "DataVersion": "sample string 22",
    "ApiName": ""
  },
  "PrincipalPhone": {
    "MessageDeviceType": "sample string 1",
    "MessageDeviceTypeDescription": "sample string 2",
    "Number": "sample string 3",
    "Description": "sample string 4",
    "Id": "7e7f4b64-d856-4952-b6f4-fff3efbc4581",
    "DataVersion": "sample string 6",
    "ApiName": ""
  },
  "PrincipalEmail": {
    "Address": "sample string 1",
    "Description": "sample string 2",
    "Id": "7d6a4231-f94e-447a-80e6-5848ec0faf87",
    "DataVersion": "sample string 4",
    "ApiName": ""
  },
  "Id": "8862c777-5403-4aa5-932a-4e21cf1819f0",
  "DataVersion": "sample string 23",
  "ApiName": ""
}

application/xml, text/xml

Sample:

<Site xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi.v1">
  <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 23</DataVersion>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">8862c777-5403-4aa5-932a-4e21cf1819f0</Id>
  <AllowTeacherOverrideAttendance>true</AllowTeacherOverrideAttendance>
  <AllowTeacherOverrideEligibility>true</AllowTeacherOverrideEligibility>
  <AllowTeacherOverrideEvalMark>true</AllowTeacherOverrideEvalMark>
  <BeginGradeUid>sample string 6</BeginGradeUid>
  <CalendarSummarySIFRefId>484d51ec-cac4-4c94-9246-6f69e23ff89a</CalendarSummarySIFRefId>
  <ContactAddress>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 15</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">a1650fa8-6062-4781-86fc-8c52509cd2cc</Id>
    <AddressType>sample string 1</AddressType>
    <AddressTypeDescription>sample string 2</AddressTypeDescription>
    <Apartment>sample string 6</Apartment>
    <City>sample string 7</City>
    <Country>sample string 9</Country>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <Line3>sample string 5</Line3>
    <PostalCode>sample string 10</PostalCode>
    <RoomNumber>sample string 13</RoomNumber>
    <State>sample string 8</State>
    <Zip>sample string 11</Zip>
    <ZipPlusFour>sample string 12</ZipPlusFour>
  </ContactAddress>
  <ContactEmail>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">7d6a4231-f94e-447a-80e6-5848ec0faf87</Id>
    <Address>sample string 1</Address>
    <Description>sample string 2</Description>
  </ContactEmail>
  <ContactPerson>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">58de50b2-f7df-4370-961a-6238a521c09b</Id>
    <AlternateFirstName>sample string 6</AlternateFirstName>
    <AlternateLastName>sample string 7</AlternateLastName>
    <AmericanIndian>true</AmericanIndian>
    <Asian>true</Asian>
    <BirthDate>2025-04-26T00:08:33.1779283-05:00</BirthDate>
    <Black>true</Black>
    <EmployerName>sample string 18</EmployerName>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 9</Gender>
    <HispanicLatino>true</HispanicLatino>
    <LanguageCodeDescription>sample string 20</LanguageCodeDescription>
    <LanguageCodeUid>sample string 19</LanguageCodeUid>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <PacificIslander>true</PacificIslander>
    <SSN>sample string 8</SSN>
    <Suffix>sample string 5</Suffix>
    <Title>sample string 1</Title>
    <UnknownRace>true</UnknownRace>
    <White>true</White>
  </ContactPerson>
  <ContactPhone>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">7e7f4b64-d856-4952-b6f4-fff3efbc4581</Id>
    <Description>sample string 4</Description>
    <MessageDeviceType>sample string 1</MessageDeviceType>
    <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
    <Number>sample string 3</Number>
  </ContactPhone>
  <EndGradeUid>sample string 7</EndGradeUid>
  <Grades>
    <Grade>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 7</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">be970970-f9e1-42af-9f84-ff2f4cd0bdd7</Id>
      <Description>sample string 2</Description>
      <GradeOrder>5</GradeOrder>
      <NextGradeId>d38710f4-5b96-4631-9157-25c23d8a2478</NextGradeId>
      <UID>sample string 1</UID>
      <YearsTilGraduation>3</YearsTilGraduation>
    </Grade>
    <Grade>
      <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 7</DataVersion>
      <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">be970970-f9e1-42af-9f84-ff2f4cd0bdd7</Id>
      <Description>sample string 2</Description>
      <GradeOrder>5</GradeOrder>
      <NextGradeId>d38710f4-5b96-4631-9157-25c23d8a2478</NextGradeId>
      <UID>sample string 1</UID>
      <YearsTilGraduation>3</YearsTilGraduation>
    </Grade>
  </Grades>
  <GraduationDate>2025-04-26T00:08:33.1779283-05:00</GraduationDate>
  <LastDayOfFirstQuarter>2025-04-26T00:08:33.1779283-05:00</LastDayOfFirstQuarter>
  <LunchMinutes>8</LunchMinutes>
  <NCESID>sample string 21</NCESID>
  <Name>sample string 4</Name>
  <OperationalStatus>sample string 14</OperationalStatus>
  <PrincipalEmail>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 4</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">7d6a4231-f94e-447a-80e6-5848ec0faf87</Id>
    <Address>sample string 1</Address>
    <Description>sample string 2</Description>
  </PrincipalEmail>
  <PrincipalPerson>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 22</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">58de50b2-f7df-4370-961a-6238a521c09b</Id>
    <AlternateFirstName>sample string 6</AlternateFirstName>
    <AlternateLastName>sample string 7</AlternateLastName>
    <AmericanIndian>true</AmericanIndian>
    <Asian>true</Asian>
    <BirthDate>2025-04-26T00:08:33.1779283-05:00</BirthDate>
    <Black>true</Black>
    <EmployerName>sample string 18</EmployerName>
    <FirstName>sample string 2</FirstName>
    <Gender>sample string 9</Gender>
    <HispanicLatino>true</HispanicLatino>
    <LanguageCodeDescription>sample string 20</LanguageCodeDescription>
    <LanguageCodeUid>sample string 19</LanguageCodeUid>
    <LastName>sample string 4</LastName>
    <MiddleName>sample string 3</MiddleName>
    <PacificIslander>true</PacificIslander>
    <SSN>sample string 8</SSN>
    <Suffix>sample string 5</Suffix>
    <Title>sample string 1</Title>
    <UnknownRace>true</UnknownRace>
    <White>true</White>
  </PrincipalPerson>
  <PrincipalPhone>
    <DataVersion xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">sample string 6</DataVersion>
    <Id xmlns="http://schemas.datacontract.org/2004/07/MAS.WebApi">7e7f4b64-d856-4952-b6f4-fff3efbc4581</Id>
    <Description>sample string 4</Description>
    <MessageDeviceType>sample string 1</MessageDeviceType>
    <MessageDeviceTypeDescription>sample string 2</MessageDeviceTypeDescription>
    <Number>sample string 3</Number>
  </PrincipalPhone>
  <ProvisionStatus>sample string 15</ProvisionStatus>
  <SIFReported>true</SIFReported>
  <SchoolType>sample string 11</SchoolType>
  <SchoolYear>1</SchoolYear>
  <SessionType>sample string 12</SessionType>
  <SiteUid>sample string 2</SiteUid>
  <StatePrId>sample string 3</StatePrId>
  <Title1Status>sample string 13</Title1Status>
  <Url>sample string 5</Url>
</Site>