Reference for http://api.mybps.org/BPSDiscoverService/Schools.svc/HomeSchools?schyear={SCHOOLYEAR}&Grade={GRADE}&SiblingSchList={SIBLINGSCHLIST}&AddressID={ADDRESSID}&IsAwc={ISAWC}
Url: http://api.mybps.org/BPSDiscoverService/Schools.svc/HomeSchools?schyear={SCHOOLYEAR}&Grade={GRADE}&SiblingSchList={SIBLINGSCHLIST}&AddressID={ADDRESSID}&IsAwc={ISAWC}
HTTP Method: GET
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<ValidSchoolChoices xmlns="http://schemas.datacontract.org/2004/07/BostonPublicSchools.Core.base"> <Error> <ErrorModule.bpsError xmlns="http://schemas.datacontract.org/2004/07/BostonPublicSchools"> <ID>String content</ID> <Message>String content</Message> <Method>String content</Method> </ErrorModule.bpsError> <ErrorModule.bpsError xmlns="http://schemas.datacontract.org/2004/07/BostonPublicSchools"> <ID>String content</ID> <Message>String content</Message> <Method>String content</Method> </ErrorModule.bpsError> </Error> <List> <SchoolChoice> <AssignmentWalkEligibilityStatus>String content</AssignmentWalkEligibilityStatus> <DeseTier>String content</DeseTier> <Eligibility>String content</Eligibility> <Grade>String content</Grade> <IsAwc>true</IsAwc> <IsExamSchool>String content</IsExamSchool> <IsSpecAdmission>true</IsSpecAdmission> <NumClasses>String content</NumClasses> <ProgramCode>String content</ProgramCode> <SchoolID>String content</SchoolID> <SchoolName>String content</SchoolName> <SchoolYear>String content</SchoolYear> <SortClause>String content</SortClause> <StraightLineDistance>String content</StraightLineDistance> <Tier>String content</Tier> <TransEligible>String content</TransEligible> <WalkLineDistance>String content</WalkLineDistance> <X>String content</X> <Y>String content</Y> <latitude>String content</latitude> <longitude>String content</longitude> </SchoolChoice> <SchoolChoice> <AssignmentWalkEligibilityStatus>String content</AssignmentWalkEligibilityStatus> <DeseTier>String content</DeseTier> <Eligibility>String content</Eligibility> <Grade>String content</Grade> <IsAwc>true</IsAwc> <IsExamSchool>String content</IsExamSchool> <IsSpecAdmission>true</IsSpecAdmission> <NumClasses>String content</NumClasses> <ProgramCode>String content</ProgramCode> <SchoolID>String content</SchoolID> <SchoolName>String content</SchoolName> <SchoolYear>String content</SchoolYear> <SortClause>String content</SortClause> <StraightLineDistance>String content</StraightLineDistance> <Tier>String content</Tier> <TransEligible>String content</TransEligible> <WalkLineDistance>String content</WalkLineDistance> <X>String content</X> <Y>String content</Y> <latitude>String content</latitude> <longitude>String content</longitude> </SchoolChoice> </List> </ValidSchoolChoices>
The following is an example response Json body:
{ "Error":[{ "ID":"String content", "Message":"String content", "Method":"String content" }], "List":[{ "AssignmentWalkEligibilityStatus":"String content", "DeseTier":"String content", "Eligibility":"String content", "Grade":"String content", "IsAwc":true, "IsExamSchool":"String content", "IsSpecAdmission":true, "NumClasses":"String content", "ProgramCode":"String content", "SchoolID":"String content", "SchoolName":"String content", "SchoolYear":"String content", "SortClause":"String content", "StraightLineDistance":"String content", "Tier":"String content", "TransEligible":"String content", "WalkLineDistance":"String content", "X":"String content", "Y":"String content", "latitude":"String content", "longitude":"String content" }] }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/BostonPublicSchools.Core.base" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/BostonPublicSchools.Core.base" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/BostonPublicSchools" /> <xs:complexType name="ValidSchoolChoices"> <xs:sequence> <xs:element minOccurs="0" name="Error" nillable="true" xmlns:q1="http://schemas.datacontract.org/2004/07/BostonPublicSchools" type="q1:ArrayOfErrorModule.bpsError" /> <xs:element minOccurs="0" name="List" nillable="true" type="tns:ArrayOfSchoolChoice" /> </xs:sequence> </xs:complexType> <xs:element name="ValidSchoolChoices" nillable="true" type="tns:ValidSchoolChoices" /> <xs:complexType name="ArrayOfSchoolChoice"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SchoolChoice" nillable="true" type="tns:SchoolChoice" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSchoolChoice" nillable="true" type="tns:ArrayOfSchoolChoice" /> <xs:complexType name="SchoolChoice"> <xs:sequence> <xs:element minOccurs="0" name="AssignmentWalkEligibilityStatus" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DeseTier" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Eligibility" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Grade" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsAwc" type="xs:boolean" /> <xs:element minOccurs="0" name="IsExamSchool" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsSpecAdmission" type="xs:boolean" /> <xs:element minOccurs="0" name="NumClasses" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ProgramCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SchoolID" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SchoolName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SchoolYear" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SortClause" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StraightLineDistance" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Tier" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="TransEligible" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="WalkLineDistance" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="X" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Y" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="latitude" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="longitude" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="SchoolChoice" nillable="true" type="tns:SchoolChoice" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/BostonPublicSchools" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/BostonPublicSchools" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfErrorModule.bpsError"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ErrorModule.bpsError" nillable="true" type="tns:ErrorModule.bpsError" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfErrorModule.bpsError" nillable="true" type="tns:ArrayOfErrorModule.bpsError" /> <xs:complexType name="ErrorModule.bpsError"> <xs:sequence> <xs:element minOccurs="0" name="ID" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Message" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Method" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ErrorModule.bpsError" nillable="true" type="tns:ErrorModule.bpsError" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>