Schools
A school or collection of schools are used for people
.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Schools ::
- list [GET] https://demo.fellowshiponeapi.com/v1/People/Schools
- show [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/{id}
Method: list [GET]
The list
method will return a list of schools.
Notes ::
list
andshow
are the only available methods for this resource; this resource cannot be updated via the API- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
the API will return an html representation of the help documents for this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/help
Format ::
- json
- xml
- help
Parameters ::
- {format}
- [GET] https://demo.fellowshiponeapi.com/v1/People/Schools.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/People/Schools?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/People/Schools
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/People/Schools
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 28 Apr 2009 07:06:19 GMT
Content-Length: 48368
<?xml version="1.0" encoding="utf-8"?>
<schools>
<school json:Array="true" id="15025" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15025">
<name>AS Johnston Elem.</name>
</school>
<school json:Array="true" id="15026" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15026">
<name>Alice Ponder Elem.</name>
</school>
<school json:Array="true" id="15027" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15027">
<name>Arbor Creek</name>
</school>
<school json:Array="true" id="15028" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15028">
<name>Argyle Elementary</name>
</school>
<school json:Array="true" id="15029" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15029">
<name>Austin Elementary</name>
</school>
<school json:Array="true" id="15030" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15030">
<name>Austin Middle</name>
</school>
<school json:Array="true" id="15031" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15031">
<name>Barbara Gordon Mont.</name>
</school>
<school json:Array="true" id="15032" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15032">
<name>Barbra Bush</name>
</school>
<school json:Array="true" id="15033" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15033">
<name>Barnett Jr. High</name>
</school>
...
</schools>
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/People/Schools.json
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/People/Schools.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:50:20 GMT
Content-Length: 40695
{
"schools": {
"school": [
{
"@array": "true",
"@id": "15025",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15025",
"name": "AS Johnston Elem."
},
{
"@array": "true",
"@id": "15026",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15026",
"name": "Alice Ponder Elem."
},
{
"@array": "true",
"@id": "15027",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15027",
"name": "Arbor Creek"
},
{
"@array": "true",
"@id": "15028",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15028",
"name": "Argyle Elementary"
},
{
"@array": "true",
"@id": "15029",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15029",
"name": "Austin Elementary"
},
...
]
}
}
Method: show [GET]
The show
method will return a single school for a given id
.
Notes ::
list
andshow
are the only available methods on this resource; this resource cannot be updated via the API- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
for a single version of this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/xsd
Format ::
- json
- xml
- xsd
Parameters ::
- {format}
- [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/{id}.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/{id}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/15025
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/People/Schools/15025
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 05:56:32 GMT
Content-Length: 146
<?xml version="1.0" encoding="utf-8"?>
<school id="15025" uri="https://demo.fellowshiponeapi.com/v1/People/Schools/15025">
<name>AS Johnston Elem.</name>
</school>
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/People/Schools/15025.json
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/People/Schools/15025.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:53:35 GMT
Content-Length: 117
{
"school": {
"@id": "15025",
"@uri": "https://demo.fellowshiponeapi.com/v1/People/Schools/15025",
"name": "AS Johnston Elem."
}
}