search

USACE / cwms-data-api

Corps Water Management System RESTful Data Service
MIT License
9 stars 13 forks source link

Create a Rate Endpoint #641

Open krowvin opened 1 month ago

krowvin commented 1 month ago

Rate Endpoint - GET

Creation of an endpoint that allows you to rate various curves in Oracle and returns the result(s)

This is more efficient than pulling that curves/specs and attempting to rate on the client in various different methods than what is already established in the procedures/functions in Oracle.

Especially given some ratings (EXSA / expanded) have thousands of points and would create IO/Bandwidth/time issues on clients.

Starting Ideas :

Gate Settings -> Flow Stage -> Regulated Flow

District Endpoints - i.e. Custom

As a means of attempting a district specific endpoint for 1 off's I can create this in a /cwms-data/swt/rate endpoint that could then be bubbled up to the national once complete.

Given this is something we need as a national endpoint anyways. see #393

@adamkorynta @rma-rripken I will report here as I run into roadblocks. But do you have any references you can email/share here as to how you/REGI/CMWS expects these payloads? Ideally I will keep it data in - data out from the procedures. But if you have specifics in mind i'm all ears. Otherwise I will start on this and we can build the payloads up/down based on needs.

MikeNeilson commented 1 month ago

@rma-rripken / @adamkorynta please coordinate with Charles as appropriate on the design and implementation of this endpoint.