Page History

Return a single Device matching a specific Device Code

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

Return all of the Devices where the Device Name contains a keyword

• Not case sensitive
• Contains

Return all Devices that are deployed at a specific Location

• Location Code must be valid and match exactly, including case
• Specific Location Codes can be obtained using the locations service

Return all Devices belonging to a specific Device Category

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

Return all Devices that have a sensor for a specific Property

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

Return all Devices that have the ability to return a specific Data Product

• 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 Devices that have a Deployment Beginning on or after a specific date/time

• Requires deploymentEndWhen the depolymentBegin filter is included, the deploymentEnd filter must also be included

Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• DateTime is represented in Coordinated Universal Time (UTC) 

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

Return all of the Devices that have a Deployment Ending on or before a specific date/time

• Requires deploymentBeginWhen the deploymentEnd filter is included, the deploymentBegin filter must also be included

Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

• DateTime is represented in Coordinated Universal Time (UTC)

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

"deviceCode":"BC_POD1_AD2M"

"deviceId":11302

Returns a list of data ratings and date from for each device

Each data rating is made up of:

1. Key : "samplePeriod", Value : sample period in seconds
2. Key : "dateFrom", Value : "dateFrom of sample period"

The list of controlled vocabulary terms associated with the device and any device groups the device belongs to.

Each vocabulary term is made up of:

1. Key : "vocabulary" Value : "title of the vocabulary term belongs to"
2. Key : "uri" Value : "URL of the vocabulary term"

Invalid Time Range, Start Time is greater

than End Time or start time is not provided

Occurs when the deploymentEnd is before the deploymentBegin date/time.

• The name of both of the datetime filters will be is included in the "parameter" property

Occurs when an invalid code is used in the filter. Most filters require an exact match, otherwise this error will occur.

• The name of the filter parameter will be is included in the "parameter" property

Occurs when multiple parameters are needed, but not all are present. Occurs when deploymentBegin is used without deploymentEnd

• The names of the required filter parameters will be is included in the "parameter" property separated by /

Occurs when a filter parameter is used, but is not supported.