Page History

Return a single Location matching a specific Location Code.

• Location Code must be valid and match exactly, including case.
• Specific Location Codes can be found by simply running the service without this parameter to get a list of all locations.

Return all Locations that have devices with a specific Device Category Code.

• Device Category Code must be valid and match exactly, including case.
• Specific Device Category Codes can be obtained using the deviceCategories service.

Return all Locations that have devices with a sensor with a specific Property Code.

• Property Code must be valid and match exactly, including case.
• Specific Property Codes can be obtained using the properties service.

Return all of the Locations that support a specific Data Product Code.

• Data Product Code must be valid and match exactly, including case.
• Specific Data Product Codes can be obtained from the dataProducts service.

Return all of the Locations that have a Deployment Beginning on or after a specific date/time.

Accepted DateTime formats:

• yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
  
• yyyy-MM-dd (ISO 8601 Extended)
  
• PnYnMnDTnHnMnS (ISO 8601 Duration)
  

If not specified, the default value is the beginning of time.

• DateTime is represented in Coordinated Universal Time (UTC).

• ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
• Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

dateFrom=2010-07-27T00:00:00.000Z

dateFrom=2010-07-27

dateFrom=-P1DT1H

• Previous 1 day and 1 hour, relative to the dateTo. Note the '-' before the P.

Return all of the Locations that have a Deployment Ending before a specific date/time.

Accepted DateTime formats:

• yyyy-MM-dd'T'HH:mm:ss.SSS'Z' (ISO 8601 Extended)
  
• yyyy-MM-dd (ISO 8601 Extended)
  
• PnYnMnDTnHnMnS (ISO 8601 Duration)
  

If not specified, the default value is the end of time.

• DateTime is represented in Coordinated Universal Time (UTC).

• ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
• Queries with both dateFrom and dateTo in the ISO 8601 Duration format will not be accepted.

dateTo=2016-08-01T00:00:00.000Z

dateTo=2016-08-01

dateTo=PT12H30M

• Next 12 hours and 30 minutes, relative to the dateFrom.

Return all of the Locations where the Location Name contains a keyword.

• Not case sensitive.

Return all of the Locations where a specific device with that Device Code has been deployed.

• Location Code must be valid and match exactly, including case.
• Specific Device Codes can be obtained from the devices service.

Include all of the children of a Location in the resultsReturn all Devices that are deployed at a specific Location and sub-tree Locations.

• Requires a valid

•  Location Code
• Valid values are either true or false

• If not specified, the default value is false