Action | URL format | Qualifiers | Example |
---|---|---|---|
Insert data w/instrument_id | GET | instrument_id, at, email, api_key, test | http://3.89.34.59/measurements/url_create?instrument_id=17&dccnSS=Supersaturation&dccnTempSF=Temperature Stable Flag&dccnTemp1=Temperature 1&dccnTemp2=Temperature 2&dccnTemp3=Temperature 3&dccnSamTemp=Sample Temperature&dccnIntTemp=Inlet Temperature&dccnOPCTemp=Optical Particle Counter Temperature&dccnNafTemp=Nafion Temperature&dccnSamFlow=Sample Air Flow Rate&dccnSheFlow=Shealth Air Flow Rate&dccnAbsPres=Absolute Pressure&dccnLaser=Laser Current&dccnFSMonit=First Stage Monitor Voltage&dccnDeltaT=Temperature Difference&dccnProVolt=Proportional Value Voltage&dccnAlarm=Alarm Code&dccnBinSet=Bin Setting&dccnConc=Number Concentration&dccnADCover=ADC Overflow&dccnBin1=Optical Particle Counter Bin 1 (0.25-0.75 um)&dccnBin2=Optical Particle Counter Bin 2 (0.75-0.1.25 um)&dccnBin3=Optical Particle Counter Bin 3 (1.25-0.1.75 um)&dccnBin4=Optical Particle Counter Bin 4 (1.75-0.2.25 um)&dccnBin5=Optical Particle Counter Bin 5 (2.25-0.2.75 um)&dccnBin6=Optical Particle Counter Bin 6 (2.75-0.3.25 um)&dccnBin7=Optical Particle Counter Bin 7 (3.25-0.3.75 um)&dccnBin8=Optical Particle Counter Bin 8 (3.75-4.25 um)&dccnBin9=Optical Particle Counter Bin 9 (4.25-4.75 um)&dccnBin10=Optical Particle Counter Bin 10 (4.75-5.25 um)&dccnBin11=Optical Particle Counter Bin 11 (5.25-5.75 um)&dccnBin12=Optical Particle Counter Bin 12 (5.75-6.25 um)&dccnBin13=Optical Particle Counter Bin 13 (6.25-6.75 um)&dccnBin14=Optical Particle Counter Bin 14 (6.75-7.25 um)&dccnBin15=Optical Particle Counter Bin 15 (7.25-7.75 um)&dccnBin16=Optical Particle Counter Bin 16 (7.75-8.25 um)&dccnBin17=Optical Particle Counter Bin 17 (8.25-8.75 um)&dccnBin18=Optical Particle Counter Bin 18 (8.75-9.25 um)&dccnBin19=Optical Particle Counter Bin 19 (9.25-9.75 um)&dccnBin20=Optical Particle Counter Bin 20 (9.75-10.25 um)&at=2015-08-20T19:50:28&email=[USER_EMAIL]&api_key=[API_KEY]&test |
Fetch a CSV file | .csv | start, end, last |
http://3.89.34.59/api/v1/data/17.csv?start=2015-08-01T00:30&end=2015-08-20T12:30
http://3.89.34.59/api/v1/data/17.csv?last |
Fetch a GeoJSON file | .geojson | start, end, last |
http://3.89.34.59/api/v1/data/17.geojson
http://3.89.34.59/api/v1/data/17.geojson?start=2015-08-01T00:30&end=2015-08-20T12:30 http://3.89.34.59/api/v1/data/17.geojson?last |
Action | URL format | Qualifiers | Example |
---|---|---|---|
Download all instruments for past 24 hours | GET |
http://3.89.34.59/api/v1/data
http://3.89.34.59/api/v1/data.json http://3.89.34.59/api/v1/data.geojson |
|
Download all instruments for past 24 hours with authentication | GET | email, api_key | http://3.89.34.59/api/v1/data?email=[USER_EMAIL]&api_key=[API_KEY] |
Download all instruments w/date range | GET | start, end | http://3.89.34.59/api/v1/data?start=2015-08-01T00:30&end=2015-08-20T12:30 |
Download all instruments w/date range test data only | GET | start, end, test | http://3.89.34.59/api/v1/data?start=2015-08-01T00:30&end=2015-08-20T12:30&test |
Download multiple instruments w/instrument ids | GET | instruments, start, end | http://3.89.34.59/api/v1/data?instruments=1,2,3&start=2015-08-01T00:30&end=2015-08-20T12:30 |
Download multiple instruments w/sensor ids | GET | sensors, start, end | http://3.89.34.59/api/v1/data?sensors=sen1,sen2,sen3&start=2015-08-01T00:30&end=2015-08-20T12:30 |
Optional Qualifiers |
Meaning |
---|---|
sensor_id= SENSOR_ID | A sensor id may be specified instead of the numerical instrument id, this value superceeds instrument id if both are given |
at= time | A time to assign to the measurement. If not present, the measurement will be time stamped with the time that it was received by the portal. |
api_key= API_KEY | An optional validation key. It is required if "Require the security key in order to submit a measurement" is checked in the configuration. The api key value is specified in the user configuration. |
email= USER_EMAIL | A user email is required when supplying an API Key to access secured data. |
test | If present, this measurement will be marked as a test value. Test values can be deleted from the database using the "Delete Test Button" on the instrument page. Do not use this option for production-ready instruments. |
start= time | A start time for the returned measurements. |
end= time | An end time for the returned measurements. |
last | Return all measurements for the most recent measurement time stamp. |
include_test_data=true | Include test data in data downloads. |