Filters on a date range on either TradingDate OR the appropriate PeriodStart (eg - Created/Ordered time etc)
Nullable
PeriodsContained :
TimePeriodTypeEnum
This is for matching all periods that lie within a larger timeperiod. It's a convienience property
for requesting "All days" for a single month
Eg - if the filter is requesting Day, setting this to Year will be equivalent to requesting EVERY day
for the Year containing Range
This is incompatible with AnyRange/NegateCondition/PeriodsWithin
Setting this WILL NOT override the returned TimePeriodType
Nullable
PeriodsWithin :
TimePeriodTypeEnum
This is for matching all periods that lie within a narrower timeperiod. It's a convienience property
for requesting "all hours" contained within a given day
Eg - if the filter is requesting Day, setting this to Hour will be equivalent to requesting EVERY hour
for the day(s) containing Range
This is incompatible with AnyRange/NegateCondition/PeriodsContained
Setting this WILL override the returned TimePeriodType
Nullable
Range :
Range`1
Nullable
AnyRange :
Range`1
[]
Nullable
ListCondition :
string (ISO 8601 DateTime)
[]
Nullable
Value :
string (ISO 8601 DateTime)
NegateCondition : bool
boolean inverts conditions used by this instance
Nullable
FilterID :
number (int)
The unique (per query) ID for this filter. Will be set automatically by the server, no need to set it. Duplicating this value will
likely result in query failures
Example
{
"PeriodsContained": 1,
"PeriodsWithin": 1,
"Range": {},
"AnyRange": [],
"ListCondition": ["2012-04-03T09:40:59.736Z"],
"Value": "2012-04-03T09:40:59.736Z",
"NegateCondition": true,
"FilterID": 321
}