All Classes Pages
SearchRangeParameterInformation Class Reference

Detailed Description

Range Query Parameter Representation

Range query parameters allow to specify a start and end value between which the parameter value lies.
For date query parameter values, following range format is supported:
[start,end]

  • "start" and "end" represent range start date and range end date respectively. For supported date representation and timezone refer this page.
  • The range values have to be specified within square brackets.
  • The values specified in the range are inclusive. For example [2015-12-23T08:39:16.000Z,2015-12-28T08:39:16.000Z] will fetch all records starting from 2015-12-23T08:39:16.000Z to 2015-12-28T08:39:16.000Z date.
  • At least one of "start" or "end" must be provided.
  • If only "start" is provided, the application gets all matching records "on-or-after" start date. For example [2015-12-23T08:39:16.000Z,] will fetch all records on or after 2015-12-23T08:39:16.000Z date. Note that comma is required after start date.
  • If only "end" is provided, the application gets all matching records "on-or-before" end date. For example [,2015-12-28T08:39:16.000Z] will fetch all records on or before 2015-12-28T08:39:16.000Z date. Note that comma is required before end date.