| Name | Signature | Description |
|---|
| GetAllColumns | ListColumnGroup1[] GetAllColumns() | Retrieves all the supported columns for the service; this includes their display name and a URI to refer to the column. |
| GetAllFilterDefinitions | FilterDefinitionDetails1[] GetAllFilterDefinitions() | Retrieves all the different filter definitions which can be used in filter expressions on this service. |
| GetData | ListData1 GetData(Int32 page, Int32 pagesize, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression) | Retrieves a page of data. "page" is a one-based page count; "pagesize" is the number of records on each page; "sort" is an array of sort clauses to apply to the data, and can be null; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output. |
| GetRowCounts | Int32[] GetRowCounts(FilterExpression1[] filterExpressions, Uri[] columnUris) | Calculates the number of rows that are expected to be available, for a given set of filter expressions and columns. A filter expression can be 'null' to represent a complete row count without filtering. The result is not guaranteed to be accurate; approximations may be used when large numbers of records are available. |
| GetTimeSeriesData | TimeSeriesData1 GetTimeSeriesData(Int32 page, Int32 pagesize, Uri[] columnUris, ListSort1[] sort, FilterExpression1 filterExpression, Uri periodResolutionUri) | Retrieves a page of data. "page" is a one-based page count; "pagesize" is the number of records on each page; "sort" is an array of sort clauses to apply to the data, and can be null; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output. Cells of value columns will come back as cell collections with the period details in periodValue. The total for the whole time series will be the value of the cell containing the cell collection. The EntryDate filter must be included in the filterExpression to use this method. |
| GetTimeSeriesData2 | TimeSeriesData1 GetTimeSeriesData2(Int32 page, Int32 pagesize, Uri[] columnUris, ListTimePeriodSort1[] sort, FilterExpression1 filterExpression, Uri periodResolutionUri) | Retrieves a page of data. "page" is a one-based page count; "pagesize" is the number of records on each page; "sort" is an array of sort clauses to apply to the data, and can be null; "filterExpression" is used to exclude some data rows, and can be null; columnUris is an array of column Uri that are included in the output. Cells of value columns will come back as cell collections with the period details in periodValue. The total for the whole time series will be the value of the cell containing the cell collection. The EntryDate filter must be included in the filterExpression to use this method. |
| GetTimeSeriesTotals | TimeSeriesDataRow1 GetTimeSeriesTotals(FilterExpression1 filterExpression, Uri[] columnUris, Uri periodResolutionUri) | Calculates per-column totals over the range of data. "filterExpression" is used to exclude some data rows from the calculation, and can be null; "columnUris" is an array of column Uri to total. A data row is returned; for columns that cannot be aggregated (eg. text columns like "Name"), a data cell of null type is expected. Cells of value columns will come back as cell collections with the period details in periodValue. The total for the whole time series will be the value of the cell containing the cell collection. The EntryDate filter must be included in the filterExpression to use this method. |
| GetTotals | ListDataRow1 GetTotals(FilterExpression1 filterExpression, Uri[] columnUris) | Calculates per-column totals over the range of data. "filterExpression" is used to exclude some data rows from the calculation, and can be null; "columnUris" is an array of column Uri to total. A data row is returned; for columns that cannot be aggregated (eg. text columns like "Name"), a data cell of null type is expected. |