POST v{version}/schools

Gets paged result of schools

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

query defition

SchoolsLimiter

Name	Description	Type	Additional information
Take		integer	None.
Skip		integer	None.
Name	Filter using contains	string	None.
Sort	Available fields: Name	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Take": 1,
  "Skip": 2,
  "Name": "sample string 3",
  "Sort": "sample string 4"
}

application/xml, text/xml

Sample:

<SchoolsLimiter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels">
  <Name>sample string 3</Name>
  <Skip>2</Skip>
  <Sort>sample string 4</Sort>
  <Take>1</Take>
</SchoolsLimiter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

paged result

IPagedResultOfSchoolViewModel

Name	Type	Additional information
Results	Collection of SchoolViewModel	None.
TotalResults	integer	None.
RequestResults	integer	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.