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

Request Information

URI Parameters

Name	Description	Type	Additional information
lang		string	Default value is en

Body Parameters

DataSourceRequest

Name	Type	Additional 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.
GroupPaging	boolean	None.
IncludeSubGroupCount	boolean	None.
Skip	integer	None.
Take	integer	None.
CaseSensitiveFilter	boolean	None.
IsExcelExportRequest	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Page": 1,
  "PageSize": 1,
  "Sorts": [
    {
      "Member": "sample string",
      "SortDirection": 0,
      "SortCompare": null
    },
    {
      "Member": "sample string",
      "SortDirection": 0,
      "SortCompare": null
    }
  ],
  "Filters": [
    null,
    null
  ],
  "Groups": [
    {
      "MemberType": null,
      "DisplayContent": "sample string",
      "AggregateFunctions": [],
      "Member": "sample string",
      "SortDirection": 0,
      "SortCompare": null
    },
    {
      "MemberType": null,
      "DisplayContent": "sample string",
      "AggregateFunctions": [],
      "Member": "sample string",
      "SortDirection": 0,
      "SortCompare": null
    }
  ],
  "Aggregates": [
    {
      "Aggregates": [
        null,
        null
      ],
      "Member": "sample string"
    },
    {
      "Aggregates": [
        null,
        null
      ],
      "Member": "sample string"
    }
  ],
  "GroupPaging": true,
  "IncludeSubGroupCount": true,
  "Skip": 1,
  "Take": 1,
  "CaseSensitiveFilter": true,
  "IsExcelExportRequest": true
}

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</d2p1:Member>
    </d2p1:AggregateDescriptor>
    <d2p1:AggregateDescriptor>
      <d2p1:Member>sample string</d2p1:Member>
    </d2p1:AggregateDescriptor>
  </Aggregates>
  <CaseSensitiveFilter>true</CaseSensitiveFilter>
  <Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType i:nil="true" />
    <d2p1:anyType i:nil="true" />
  </Filters>
  <GroupPaging>true</GroupPaging>
  <Groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc">
    <d2p1:GroupDescriptor>
      <d2p1:Member>sample string</d2p1:Member>
      <d2p1:SortCompare i:nil="true" />
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
      <d2p1:AggregateFunctions />
      <d2p1:DisplayContent xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">sample string</d2p1:DisplayContent>
      <d2p1:MemberType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
    </d2p1:GroupDescriptor>
    <d2p1:GroupDescriptor>
      <d2p1:Member>sample string</d2p1:Member>
      <d2p1:SortCompare i:nil="true" />
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
      <d2p1:AggregateFunctions />
      <d2p1:DisplayContent xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string">sample string</d2p1:DisplayContent>
      <d2p1:MemberType xmlns:d4p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
    </d2p1:GroupDescriptor>
  </Groups>
  <IncludeSubGroupCount>true</IncludeSubGroupCount>
  <IsExcelExportRequest>true</IsExcelExportRequest>
  <Page>1</Page>
  <PageSize>1</PageSize>
  <Skip>1</Skip>
  <Sorts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Kendo.Mvc">
    <d2p1:SortDescriptor>
      <d2p1:Member>sample string</d2p1:Member>
      <d2p1:SortCompare i:nil="true" />
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:SortDescriptor>
    <d2p1:SortDescriptor>
      <d2p1:Member>sample string</d2p1:Member>
      <d2p1:SortCompare i:nil="true" />
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:SortDescriptor>
  </Sorts>
  <Take>1</Take>
</DataSourceRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DataSourceResult

Name	Type	Additional information
Data	IEnumerable	None.
Total	integer	None.
AggregateResults	Collection of AggregateResult	None.
Errors	Object	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

Sample not available.