Create new Flow Meter
  • 17 Jan 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create new Flow Meter

  • Dark
    Light
  • PDF

Article summary

Post
/flow-meters/
Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Flow Meter to be created

object
Class_id
integer Required

Flow Meter Class Id

Consumer_id
integer Required

Consumer Point Id

FlowType_id
integer

Flow Meter Type Id

Size_id
integer

Flow Meter Size Id

WaterType_id
integer

Flow Meter Water Type Id

backwards
boolean

Flow direction

consumption_estimate
integer

Consumption estimate

flow_number
string Required

Flow number

id
integer

Primary key

install_date
string (date) Required

Install date

max_reading
integer

Maximum reading

module_number
string

Module number

removed
integer

Flag for removed status

route_number
string

Route number

waterdb_id
string

Water Database Id

Responses
201

A created Flow Meter

object
Class_id
integer

Flow Meter Class Id

Consumer_id
integer

Consumer Point Id

FlowType_id
integer

Flow Meter Type Id

Size_id
integer

Flow Meter Size Id

WaterType_id
integer

Flow Meter Water Type Id

backwards
boolean

Flow direction

consumption_estimate
integer

Consumption estimate

flow_number
string

Flow number

id
integer

Primary key

install_date
string (date)

Install date

max_reading
integer

Maximum reading

module_number
string

Module number

removed
integer

Flag for removed status

route_number
string

Route number

waterdb_id
string

Water Database Id

400

There was an error in request. Usually field validation failed.

{
  "flow_number": [
    "This field is required."
  ],
  "install_date": [
    "This field is required."
  ]
}

Fields which failed validation

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error


Was this article helpful?