GET api/Data/Area

Returns Area Table data

Request Information

URI Parameters

None.

Body Parameters

TableParameters
NameDescriptionTypeAdditional information
Columns

The desired Filters for the query

Collection of string

Required

Filters

The desired Filters for the query

Collection of Filters

Required

SortBy

The desired Sort for the query

Collection of SortBy

None.

Request Formats

application/json, text/json

Sample:
{
  "Columns": [
    "sample string 1",
    "sample string 2"
  ],
  "Filters": [
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Threshold": "sample string 3",
      "From_Threshold": "sample string 4",
      "To_Threshold": "sample string 5"
    },
    {
      "Column": "sample string 1",
      "Operator": "sample string 2",
      "Threshold": "sample string 3",
      "From_Threshold": "sample string 4",
      "To_Threshold": "sample string 5"
    }
  ],
  "SortBy": [
    {
      "Column": "sample string 1",
      "Direction": "sample string 2"
    },
    {
      "Column": "sample string 1",
      "Direction": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<TableParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EQR_API_MVC.Controllers">
  <Columns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Columns>
  <Filters>
    <Filters>
      <Column>sample string 1</Column>
      <From_Threshold>sample string 4</From_Threshold>
      <Operator>sample string 2</Operator>
      <Threshold>sample string 3</Threshold>
      <To_Threshold>sample string 5</To_Threshold>
    </Filters>
    <Filters>
      <Column>sample string 1</Column>
      <From_Threshold>sample string 4</From_Threshold>
      <Operator>sample string 2</Operator>
      <Threshold>sample string 3</Threshold>
      <To_Threshold>sample string 5</To_Threshold>
    </Filters>
  </Filters>
  <SortBy>
    <SortBy>
      <Column>sample string 1</Column>
      <Direction>sample string 2</Direction>
    </SortBy>
    <SortBy>
      <Column>sample string 1</Column>
      <Direction>sample string 2</Direction>
    </SortBy>
  </SortBy>
</TableParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RequestArea
NameDescriptionTypeAdditional information
Message

string

None.

Status

string

None.

NumberOfRecords

integer

None.

Data

Collection of Area

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Status": "sample string 2",
  "NumberOfRecords": 3,
  "Data": [
    {
      "Ar_ID": 1,
      "Ar_Name": "sample string 1"
    },
    {
      "Ar_ID": 1,
      "Ar_Name": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiDataModels.Requests.RequestArea xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EQR_API_MVC.Models">
  <Data>
    <ApiDataModels.Data.Area>
      <Ar_ID>1</Ar_ID>
      <Ar_Name>sample string 1</Ar_Name>
    </ApiDataModels.Data.Area>
    <ApiDataModels.Data.Area>
      <Ar_ID>1</Ar_ID>
      <Ar_Name>sample string 1</Ar_Name>
    </ApiDataModels.Data.Area>
  </Data>
  <Message>sample string 1</Message>
  <NumberOfRecords>3</NumberOfRecords>
  <Status>sample string 2</Status>
</ApiDataModels.Requests.RequestArea>