POST api/Agencies/GetDataset?lang={lang}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
lang

string

Default value is en

Body Parameters

DataSourceRequest
NameDescriptionTypeAdditional information
Page

integer

None.

PageSize

integer

None.

Sorts

Collection of SortDescriptor

None.

Filters

Collection of IFilterDescriptor

None.

Groups

Collection of GroupDescriptor

None.

Aggregates

Collection of AggregateDescriptor

None.

Request Formats

application/json, text/json

Sample:
{
  "Page": 1,
  "PageSize": 2,
  "Sorts": [
    {
      "Member": "sample string 1",
      "SortDirection": 0
    },
    {
      "Member": "sample string 1",
      "SortDirection": 0
    }
  ],
  "Filters": null,
  "Groups": [
    {
      "MemberType": null,
      "DisplayContent": {},
      "AggregateFunctions": [],
      "Member": "sample string 2",
      "SortDirection": 0
    },
    {
      "MemberType": null,
      "DisplayContent": {},
      "AggregateFunctions": [],
      "Member": "sample string 2",
      "SortDirection": 0
    }
  ],
  "Aggregates": [
    {
      "Aggregates": null,
      "Member": "sample string 1"
    },
    {
      "Aggregates": null,
      "Member": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<DataSourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kendo.Mvc.UI">
  <Aggregates xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc">
    <d2p1:AggregateDescriptor>
      <d2p1:Member>sample string 1</d2p1:Member>
    </d2p1:AggregateDescriptor>
    <d2p1:AggregateDescriptor>
      <d2p1:Member>sample string 1</d2p1:Member>
    </d2p1:AggregateDescriptor>
  </Aggregates>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <Groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc">
    <d2p1:GroupDescriptor>
      <d2p1:Member>sample string 2</d2p1:Member>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
      <d2p1:AggregateFunctions />
      <d2p1:DisplayContent />
      <d2p1:MemberType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
    </d2p1:GroupDescriptor>
    <d2p1:GroupDescriptor>
      <d2p1:Member>sample string 2</d2p1:Member>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
      <d2p1:AggregateFunctions />
      <d2p1:DisplayContent />
      <d2p1:MemberType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
    </d2p1:GroupDescriptor>
  </Groups>
  <Page>1</Page>
  <PageSize>2</PageSize>
  <Sorts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc">
    <d2p1:SortDescriptor>
      <d2p1:Member>sample string 1</d2p1:Member>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:SortDescriptor>
    <d2p1:SortDescriptor>
      <d2p1:Member>sample string 1</d2p1:Member>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:SortDescriptor>
  </Sorts>
</DataSourceRequest>

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 'DataSourceRequest'.

Response Information

Resource Description

DataSourceResult
NameDescriptionTypeAdditional information
Data

Collection of Object

None.

Total

integer

None.

AggregateResults

Collection of AggregateResult

None.

Errors

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {},
    {}
  ],
  "Total": 1,
  "AggregateResults": null,
  "Errors": {}
}

application/xml, text/xml

Sample:
<DataSourceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kendo.Mvc.UI">
  <AggregateResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc.Infrastructure" i:nil="true" />
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Data>
  <Errors />
  <Total>1</Total>
</DataSourceResult>