POST api/schoolreport/showreportingdetails

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Draw	integer	None.
Start	integer	None.
Length	integer	None.
Param	Object	None.
Order	Collection of DataTableOrder	None.
Columns	Collection of DataTableColumn	None.
Search	DataTableSearch	None.

Request Formats

application/json, text/json

Sample:

{
  "Draw": 1,
  "Start": 2,
  "Length": 3,
  "Param": {},
  "Order": [
    {
      "Column": 1,
      "Dir": "sample string 2"
    },
    {
      "Column": 1,
      "Dir": "sample string 2"
    }
  ],
  "Columns": [
    {
      "Data": "sample string 1",
      "Name": "sample string 2",
      "Searchable": true,
      "Orderable": true,
      "Search": {
        "Value": "sample string 1",
        "Regex": true
      }
    },
    {
      "Data": "sample string 1",
      "Name": "sample string 2",
      "Searchable": true,
      "Orderable": true,
      "Search": {
        "Value": "sample string 1",
        "Regex": true
      }
    }
  ],
  "Search": {
    "Value": "sample string 1",
    "Regex": true
  }
}

application/xml, text/xml

Sample:

<DataTableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSC_API.Datatables">
  <Columns>
    <DataTableColumn>
      <Data>sample string 1</Data>
      <Name>sample string 2</Name>
      <Orderable>true</Orderable>
      <Search>
        <Regex>true</Regex>
        <Value>sample string 1</Value>
      </Search>
      <Searchable>true</Searchable>
    </DataTableColumn>
    <DataTableColumn>
      <Data>sample string 1</Data>
      <Name>sample string 2</Name>
      <Orderable>true</Orderable>
      <Search>
        <Regex>true</Regex>
        <Value>sample string 1</Value>
      </Search>
      <Searchable>true</Searchable>
    </DataTableColumn>
  </Columns>
  <Draw>1</Draw>
  <Length>3</Length>
  <Order>
    <DataTableOrder>
      <Column>1</Column>
      <Dir>sample string 2</Dir>
    </DataTableOrder>
    <DataTableOrder>
      <Column>1</Column>
      <Dir>sample string 2</Dir>
    </DataTableOrder>
  </Order>
  <Param />
  <Search>
    <Regex>true</Regex>
    <Value>sample string 1</Value>
  </Search>
  <Start>2</Start>
</DataTableRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DataTableRequest'.

Response Information

Resource Description

DataTableResponse

Name	Type	Additional information
draw	integer	None.
recordsTotal	integer	None.
recordsFiltered	integer	None.
data	Collection of Object	None.
error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "draw": 1,
  "recordsTotal": 2,
  "recordsFiltered": 3,
  "data": [
    {},
    {}
  ],
  "error": "sample string 4"
}

application/xml, text/xml

Sample:

<DataTableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSC_API.Datatables">
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </data>
  <draw>1</draw>
  <error>sample string 4</error>
  <recordsFiltered>3</recordsFiltered>
  <recordsTotal>2</recordsTotal>
</DataTableResponse>