RTDMS REST API - Central Pollution Control Board

1 RTDMS rest API Version RTDMS rest API version 1 API to upload data of a station EndPoint Method Header Note:- Here industryId and stationId corresponding to industryId and stationId available in vendor system. Request Json Example JSON Response 2 API to upload Data of an Industry EndPoint Note:- Here industryId corresponding to industryId available in vendor system. Method Header Request Json Example Json Response 3 API to Upload Correction EndPoint Note:- Here industryId and stationId corresponding to industryId and stationId available in vendor system. Method Header Request Json Response 4 API to upload daily SMS count EndPoint Method Header Note:- Here Industry_Id refers the actual Industry Id available at vendor system. Request Json Example JSON Response 5 Annexure Parameter Keys Units Common Status Codes in Response JSON Throttling 2015 LogicLadder 1 RTDMS rest API version rest API logicladder team.

2 Access to your data. 1 API to upload data of a station stationcanhavemultipledevicesinstalledto recorddifferentenvironmentparameters(cod , bod, tss, pH, flow, Sox, Nox, PM etc). EndPoint :8080 <industryId>/station/<stationId>/data Method Request should be through POST method. Header encoded. The header format should be: <industryId>/station/<stationId>/data :8080 Authorization: Basic <token> Note:-HereindustryIdandstationIdcorrespo ndingtoindustryIdandstationIdavailablein vendor system. Request Json Note:- When device is in Calibration mode or Zero Calibration mode then vendor should capture and push one data point at every 30 sec. Thejsonshouldprovideanarrayofdataobject, specifictoeachdeviceinstalledatastation. The request json to be posted would be : 2015 LogicLadder 2 RTDMS rest API version [ { "deviceId": "xxxx", "params": [ { "parameter": "xxxx", "value": xxxx , "unit": "xxx", "timestamp": xxxx, "flag": "U|C|M|F|Z|D" } ], "diagnostics": [ { "diagParam": "xxxx", "value": xxxx, "timestamp": xxxx } ] } ] Table : Single station data upload json fields.

3 Parameters Data Type Description deviceId String Anidthatuniquelyidentifiesadevice installed at a station. params Array Arrayofparametersforwhichdatais dataspecifictothedeviceid mentionedabove,theindustryidand station id present in the request. : [{ parameter : cod , value :190, unit : mg/l timestamp :1441686170004 flag : U }, { 2015 LogicLadder 3 RTDMS rest API version parameter : bod , value :28, unit : mg/l timestamp :1441686170004 flag : U }] params: parameter String bepickedfromtheparametertablein theannexure( ).Ifa parameterisnotavailableinthelist, please inform cpcb/logicladder. params: value Decimal Value of parameter in decimal. params: unit String Unitinwhichdeviceisrecordingthe parameter. Unit should be pickedfromtheunittableinthe annexure( ).Ifaunitisnot availablepleaseinform cpcb/logicladder.

4 Params: timestamp long Epoch/Unix/Posixtimeinmilliseconds :00:00 CoordinatedUniversalTime(UTC), Thursday, 1 January 1970 params: flag String Diagnosticflagsassociatedwith andwhendifferentvendorsflagsare unified. Possible values of flag: U:usable C:calibration M:Maintenance F:Faulty Z:Zero D:Calibration Drift diagnostics Array Arrayofdiagnosticinformationofthe device. [{ 2015 LogicLadder 4 RTDMS rest API version diagParam : humidityAlert , value : 0, timestamp :1441686170004 }, { diagParam : deviceTemperature , value : 49, timestamp :1441686170004 }] diagnostics: diagParam String Name of diagnostic parameter. diagnostics: value Decimal Valueofdiagnosticparameterin decimal. diagnostics: timestamp long Epoch/Unix/Posixtimeinmilliseconds :00:00 CoordinatedUniversalTime(UTC), Thursday, 1 January 1970 Example JSON [ { "deviceId": "sn-123-d-56", "params": [ { "parameter": "cod", "value": 198 , "unit": "mg/l", "timestamp": 1441686170004, "flag": "U" }, { "parameter": "bod", "value": 28 , "unit": "mg/l", "timestamp": 1441686170004, "flag": "U" } ], 2015 LogicLadder 5 RTDMS rest API version "diagnostics": [ { "diagParam": "humidityAlert", "value": 0, "timestamp": 1441686170004 }, { "diagParam": "devTemperature", "value": 49, "timestamp": 1441686170004 } ] }, { "deviceId": "sn-124-d-58", "params": [ { "parameter": "ph", "value": , "unit": ", "timestamp": 1441686170004 "flag".]]}}

5 "U", }, ] "diagnostics": [ { "diagParam": "devTemperature", "value": 49, "timestamp": 1441686170004 } ] } ] Response Success: If data uploaded successfully HTTP STATUS200 OK { 2015 LogicLadder 6 RTDMS rest API version "msg" :"success" , status : 1 } Failure: If data upload fails HTTP STATUS other than 200 { "msg": "failed", "status": 0, "invalidIndustries": { "industries": [{ "industryId": "abc" }] }, "invalidStations": { "industries": [{ "industryId": "abc", "stations": [{ "stationId": "xyz" }] }] }, "invalidDevices": { "industries": [{ "industryId": "abc", "stations": [{ "stationId": "xyz", "devices": [{ "serialNo": "xyz" }] }] }] }, "invalidParameters": { "industries": [{ "industryId": "abc", "stations": [{ "stationId": "xyz", "devices": [{ 2015 LogicLadder 7 RTDMS rest API version "serialNo": "xyz", "parameters": [{ "parameter": "abc" }] }] }] }] }, "invalidUnits": { "industries": [{ "industryId": "abc", "stations": [{ "stationId": "xyz", "devices": [{ "serialNo": "xyz", "parameters": [{ "parameter": "abc", "unit": "mg/L" }] }] }] }] } } For status codes please refer Annexure (Table ) 2 API to upload Data of an Industry parameters (cod, bod, tss, pH, flow, Sox, Nox, PM etc).

6 EndPoint :8080 <industryId>/data Note:- Here industryId corresponding to industryId available in vendor system. Method Request should be through POST method. 2015 LogicLadder 8 RTDMS rest API version Header Base64 encoded. The header format should be: <industryId>/data :8080 Authorization: Basic <token> Request Json Note:- When device is in Calibration mode or Zero Calibration mode then vendor should capture and push one data point at every 30 sec. The request accepts an array of stations with its data. The request json to be posted would be : [ { "stationId": "xxxx", "data": [ { "deviceId": "xxxx", "params": [ { "parameter": "xxxx", "value": xxxx , "unit": "xxx", "timestamp": xxxx, "flag": "U|C|M|F|Z|D" } ], "diagnostics": [ { "diagParam": "xxxx", "value": xxxx, "timestamp": xxxx } ] } ] 2015 LogicLadder 9 RTDMS rest API version } ] Table : Multiple Station data upload json fields.

7 Parameters Data Type Description stationId String Idofthestation-ETPor Stack. data Array Datafortheparticularstation. Eachelementofarray correspondstoadevice fieldswithindatapleaserefer Table Example Json [{ "stationId": "stack1", "data": [{ "deviceId": "sn-123-d-56", "params": [{ "parameter": "cod", "value": 198, "unit": "mg/l", "timestamp": 1441686170004, "flag": "U" }, { "parameter": "bod", "value": 28, "unit": "mg/l", "timestamp": 1441686170004, "flag": "U" }], "diagnostics": [{ "diagParam": "humidityAlert", "value": 0, "timestamp": 1441686170004 }, { "diagParam": "devTemperature", 2015 LogicLadder 10 RTDMS rest API version "value": 49, "timestamp": 1441686170004 }] }, { "deviceId": "sn-124-d-58", "params": [{ "parameter": "ph", "value": , "unit": " ", "timestamp": 1441686170004, "flag": "U" }], "diagnostics": [{ "diagParam".]]]}}}

8 "devTemperature", "value": 51, "timestamp": 1441686170004 }] }] }, { "stationId": "stack2", "data": [..] }] Response Success: If data uploaded successfully HTTP STATUS200 OK { "msg" :"success" , status : 1 } Failure: If data upload fails HTTP STATUS other than 200 { 2015 LogicLadder 11 RTDMS rest API version "msg": "failed", "status": 0, "invalidIndustries": { "industries": [ { "industryId": "abc" } ] }, "invalidStations": { "industries": [ { "industryId": "abc", "stations": [ { "stationId": "xyz" } ] } ] }, "invalidDevices": { "industries": [ { "industryId": "abc", "stations": [ { "stationId": "xyz", "devices": [ { "serialNo".}}

9 "xyz" } ] } ] } ] }, "invalidParameters": { "industries": [ { "industryId": "abc", 2015 LogicLadder 12 RTDMS rest API version "stations": [ { "stationId": "xyz", "devices": [ { "serialNo": "xyz", "parameters": [ { "parameter": "abc" } ] } ] } ] } ] }, "invalidUnits": { "industries": [ { "industryId": "abc", "stations": [ { "stationId": "xyz", "devices": [ { "serialNo": "xyz", "parameters": [ { "parameter": "abc", "unit": "mg/L" } ] } ] } ] } ] } } 2015 LogicLadder 13 RTDMS rest API version For status codes please refer Annexure (Table ) 2015 LogicLadder 14 RTDMS rest API version 3 API to Upload Correction This api is used to submit corrections for a parameter.

10 A station can be an ETP or a stack. A station can have multiple devices installed to record different environment parameters (cod, bod, tss, pH, flow, Sox, Nox, PM etc). EndPoint :8080 <industryId>/station/<stationId>/correction Note:-HereindustryIdandstationIdcorrespo ndingtoindustryIdandstationIdavailablein vendor system. Method Request should be through POST method. Header encoded. The header format should be: <industryId>/station/<stationId>/data :8080 Authorization: Basic <token> Request Json request json to be posted would be : { "approvedbySPCB": "true/false", "regionalOffice": "xxxx", "officialName": "xxxx", "officialEmail": "xxxx", 2015 LogicLadder 15 RTDMS rest API version "officialContact": "xxxx", "approvalReason": "xxxx", "submittedBy": "xxxx", "submissionDateTime": "xxxx", "correctionReason": "xxxx", "requestID": "xxxx", "responseURL": "xxxx", "params": [ { "paramName": "xxxx", "data": [ { "dataTimestamp": 1441686170004 , "newValue": }, { "dataTimestamp".]]}}}