GET sites/{id}/channels/{channelId}/photos?startDateFilter={startDateFilter}&endDateFilter={endDateFilter}&intervalTypeFilter={intervalTypeFilter}&intervalNumberFilter={intervalNumberFilter}
Get data points from the specified site and photo channel, where the values retured are URL's for each photo. Filter the set of data points by providing a date range. This date range can be specified by providing either: a start and end date OR an interval type and number.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Site id of the site to retrieve data from. |
integer |
Required |
channelId |
Channel id of the channel to retrieve data from. |
integer |
Required |
startDateFilter |
The start of the date range filter. Format is 'yyyy-MM-ddTHH:mm:ss'. The time component is optional. |
date |
None. |
endDateFilter |
The end of the date range filter. Format is 'yyyy-MM-ddTHH:mm:ss'. The time component is optional. Excluding the end date filter will retrieve the most recent data up until the end of the current day. |
date |
None. |
intervalTypeFilter |
An interval type filter can be used to retrieve data for the last number of intervals. Valid interval types are: 'Y', 'M', 'D', 'HH', 'MM', and 'SS' for their respective date component. For example, an interval type of 'D' would retrieve data for the past number of days, whereas an interval type of 'HH' would instead retrieve data for the past number of hours. This filter must be used in combination with the 'intervalNumberFilter', and cannot be used with the start and end date filters. |
string |
None. |
intervalNumberFilter |
The number of date intervals to include in the retrieved data set. Must be used in combination with 'intervalTypeFilter'. For example, an interval number of 3 in combination with an interval type of 'M' would retrieve data for the past 3 months. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseVMOfDataPointVMName | Description | Type | Additional information |
---|---|---|---|
Resources | Collection of DataPointVM |
None. |
|
ResultCode | FwApiResultCode |
None. |
|
ResultMessage | string |
None. |
Response Formats
application/json, text/json
{ "Resources": [ { "DataValue": "sample string 1", "DataTime": "2025-02-14T23:59:45.1656112-08:00" }, { "DataValue": "sample string 1", "DataTime": "2025-02-14T23:59:45.1656112-08:00" } ], "ResultCode": 0, "ResultMessage": "sample string 1" }
application/xml, text/xml
<ResponseVMOfDataPointVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels"> <ResultCode>Ok</ResultCode> <ResultMessage>sample string 1</ResultMessage> <Resources> <DataPointVM> <DataTime>2025-02-14T23:59:45.1656112-08:00</DataTime> <DataValue>sample string 1</DataValue> </DataPointVM> <DataPointVM> <DataTime>2025-02-14T23:59:45.1656112-08:00</DataTime> <DataValue>sample string 1</DataValue> </DataPointVM> </Resources> </ResponseVMOfDataPointVMFXJgzlgx>