KWRIS

Water Resources Department
Advanced Center for Integrated Water Resources Management

Web Services are a method of communication over the network. A Web service is a system dedicated for supporting machine-to-machine transactions over a network.It is a Web API described in WSDL (Web Service Description Language) and Web services are usually self - contained and self - describing.Web services can be discovered using UDDI (Universal Description, Discovery and Integration) protocol.By exchanging SOAP (Simple Object Access Protocol) messages typically over HTTP (with XML), other systems can interact with Web services.Web services are used in number of ways such as RPC (Remote Procedure Calls), SOA (Service Oriented Architecture) and REST (Representational State Transfer).

REST is an architectural style, and an approach to communications that is often used in the development of Web services.The use of REST is often preferred over the more heavyweight SOAP style because REST does not leverage as much bandwidth, which makes it a better fit for use over the Internet. While initially Web APIs were also called Web services, nowadays the use of the latter form signals that the API is RESTful, as opposed to following the SOAP standard.

ACIWRM provides a host of Web API’s which includes Spatial and Non - Spatial (Data) Services to share and expose the raw data for any third party / user enabling external developers to build applications, products or to customise data.Because the APIs simply provide data, there are no limits on how a user can then go on to use that data.The Nearby Assets API is for finding the nearest assets of a department from any location within Karnataka State.It returns search results with latitude, longitude and Name of the Asset.

S.No Service Name Description
1GetAdministrativeBoundaryAdministrative Boundary
2GetHydrologicalBoundaryHydrological Boundary
3GetRainfallRainfall
4GetReservoirReservoir Master
5GettblReservoirReservoir
6GetSoilMoistureDataSoil Moisture
7GetCanalDataCanal Master
8GetCanalTelemetryCanal Telemetry
9GetGroundWaterGround Water
Administrative BoundaryGetAdministrativeBoundary
Description : Administrative Boundary
Service URL : https://kwris.azurewebsites.net/api/data/GetAdministrativeBoundary
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1DistrictCode164District Code
2BlockCode1Block Code
3GPCode1GP Code
4VillageCode1Village Code
Response
S.No Response Description
1SuccessReturns the Administrative Boundary
2FailureStatus Message.
Example
Response

[{"StateCode":"10","StateName":"Karnataka","DistrictCode":164,"DistrictName":"Bagalkot","DistrictNameKN":"ಬಾಗಲಕೋಟೆ","BlockCode":1,"BlockName":"Badami","BlockNameKN":"ಬಾದಾಮಿ","GPCode":1,"GPName":"Adagall","GPNameKN":"Adagall","VillageCode":1,"VillageName":"ADAGAL","Alternatename":"ADAGAL"}]

Hydrological BoundaryGetHydrologicalBoundary
Description : Hydrological Boundary
Service URL : https://kwris.azurewebsites.net/api/data/GetHydrologicalBoundary
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1BasinID1Basin ID
2SubBasinID3Sub Basin ID
Response
S.No Response Description
1SuccessReturns the Hydrological Boundary
2FailureStatus Message
Example
Response

[{"BasinID":"6","BasinName":"Godavari","BasinNameKN":"ಗೋದಾವರಿ ಕೊಳ್ಳ","SubBasinID":19,"SubBasinName":"Godavari ","SubBasinNameKN":"ಗೋದಾವರಿ"}]

RainfallGetRainfall
Description : Rainfall
Service URL : https://kwris.azurewebsites.net/api/data/GetRainfall
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1LocationCodeAmingadLocationCode
2FromYear2020Year
3ToYear2021Year
Response
S.No Response Description
1SuccessReturns the Rainfall data
2FailureStatus Message.
Example
Response

[{"District":"Bagalkot","Taluk":"Hungund","Basin":"Krishna","SubBasin":"Malaprabha","locationCode":"Amingad","Date":"2020-06-01","RF":"4"}]

Reservoir MasterGetReservoir
Description : Reservoir Master
Service URL : https://kwris.azurewebsites.net/api/data/GetReservoir
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1ReservoirID1Reservoir ID
Response
S.No Response Description
1SuccessReturns the Reservoir master data
2FailureStatus Message.
Example
Response

[{"ReservoirID":1,"ReservoirName":"Almatti Dam","Project_Identification_Code":"KAO6H H0200","StateCode":10,"BasinID":7,"SubBasinID":226,"DistrictCode":164,"BlockCode":2,"RiverID":62,"Year":2000,"OandMby":"WRD","NearestCity":"Bagalkote","ReservoirType":"Major","Long":"75.888719000","Lat":"16.331098000","GrossStorage":"3485620.00","Volume_content":"1349.99","Reservoir_Area":"487870.00","EffectiveStorageCapacity":"2985620.00","DesignedSpillwayCapacity":"31007.00","Height":"52.24","Length":"1564.83","Purpose":"Irigation & Hydel","Flag":true,"DelSubBasin":"K4","GeoLoc":"POINT (75.888719 16.331098)","FRL":"1704.81","MDDL":"1663.04","Cill_Level":"1625.10","Design_Gross":"123.081","Design_MDDL":"105.470","Design_Cill":"119.260","LatD":null,"LatM":null,"LatS":null,"LonD":null,"LonM":null,"LonS":null,"Easting":null,"Northing":null,"CanalID":null}]

ReservoirGettblReservoir
Description : Reservoir
Service URL : https://kwris.azurewebsites.net/api/data/GettblReservoir
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1ReservoirID1Reservoir ID
2fromdate20200101From Date
3todate20200102To Date
Response
S.No Response Description
1SuccessReturns the Reservoir data
2FailureStatus Message.
Example
Response

[{"RID":112294,"ReservoirID":1,"FRL_As_Per_Design":1704.81,"FRL":1704.81,"MDDL":1663.04,"Cill_Level":1625.10,"Date":"2020-01-02T00:00:00","Reservior_Level":1700.313,"StorageCapacity_AsPerDesign":123.081,"TMC_GrossCapacity":101.080,"TMC_Live_Above_Cill":83.470,"TMC_Above_Cill":97.260,"Flow_Inflow":0.000,"Flow_OutFlow":11500.000,"Flow_Withdrawal":2118.000,"Evaporation":null,"Cum_TMC_Inflow":1196.86651100,"Cum_TMC_OutFlow":471.75878000,"Cum_TMC_Withdrawl":9.61602800,"Cum_Evaporation":null,"River_Spillway":null,"River_PowerHouse":null,"River_Sluice":null,"Other_Abstractions":null,"Foreshore_LIS":null,"Drinking_Domestic":null,"Industries":null,"Storage_Per":82.12477962,"GrossCapacity":null,"LiveCapacity":105.470,"Storage_Above_Cill":119.260,"CreatedBy":null,"CreatedOn":null,"Approvedby":"136","ApprovedOn":null}]

Soil MoistureGetSoilMoistureData
Description : Soil Moisture
Service URL : https://kwris.azurewebsites.net/api/data/GetSoilMoistureData
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1DistrictCode164District Code
2fromdate20150402From Date
3todate20150411To Date
Response
S.No Response Description
1SuccessReturns the Soil Moisture Data
2FailureStatus Message
Example
Response

[{"UID":2563,"DistrictCode":164,"DistrictName":"Bagalkot","DistrictNameKN":"????????","BlockCode":1,"BlockName":"Badami","BlockNameKN":"??????","MeanSM":2.536,"Date":"2015-04-02T00:00:00"}]

Canal MasterGetCanalData
Description : Canal Master
Service URL : https://kwris.azurewebsites.net/api/data/GetCanalData
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1CanalId65Canal Id
Response
S.No Response Description
1SuccessReturns the Canal Master Data
2FailureStatus Message
Example
Response

[{"ReservoirId":"999","Canal_ID":65,"Canal_Name":"Yettinahole","CanalShort":null,"Statecode":10,"StateName":"Karnataka","DistrictCode":179,"DistrictName":"Hassan","DistrictNameKN":"????","BlockCode":175,"BlockName":"Sakleshpur","BlockNameKN":"????????","BasinCode":15,"BasinName":"W F Rivers Basin","BasinNameKN":"?????? ????? ??? ?????","SubbasinCode":113,"canal_short":"Weir-1 ","canal_name1":"In the Rivulet downstream of Weir1","canalsubid":"Wei07052021154901473","ProjectID":"KNNL","status":"Working"}]

Canal TelemetryGetCanalTelemetry
Description : Canal Telemetry
Service URL : https://kwris.azurewebsites.net/api/data/GetCanalTelemetry
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1LocationIDWei07052021154901473Location ID (GUID)
Response
S.No Response Description
1SuccessReturns the Canal Telemetry Data
2FailureStatus Message
Example
Response

[{"Id":326009,"LocationGuid":"Wei07052021160348957","DateTime":"2021-10-06T18:26:00","Discharge":12.480,"Height":1.190,"CreatedDate":"2021-10-06T19:15:24.447","Velocity":null}]

Ground WaterGetGroundWater
Description : Ground Water
Service URL : https://kwris.azurewebsites.net/api/data/GetGroundWater
Method Type : Get
Response Type : Json
Request
S.No Parameter Sample Value Description
1LocationCode091203HPLocation Code
2FromYear2020Year
3ToYear2021Year
Response
S.No Response Description
1SuccessReturns the Ground Water Data
2FailureStatus Message
Example
Response

[{"District":"Dharwad","Taluk":"Annigeri","Basin":"Krishna","SubBasin":"Malaprabha","locationCode":"091203HP","Date":"2020-06-01","GW":"9.4"}]

Disclaimer: Though all efforts have been made to ensure the accuracy and currency of the content, the same should not be construed as a statement of law or used for any legal purposes. In case of any ambiguity or doubts, users are advised to verify/check with the Department(s) and/or other source(s), and to obtain appropriate professional advice.