Skip to content

Instantly share code, notes, and snippets.

@cn-johndpope

cn-johndpope/test.yaml Secret

Last active March 31, 2023 12:59
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save cn-johndpope/3597fb777ce43041801d661ca4b75ca7 to your computer and use it in GitHub Desktop.
Save cn-johndpope/3597fb777ce43041801d661ca4b75ca7 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
test.yaml
openapi: 3.0.1
info:
title: SETFlowAPI
version: "1.0"
servers:
- url: /
paths:
/api/configuration/{orgId}/meterType:
get:
operationId: "getMeterType"
tags:
- Configuration
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/MeterTypeModel'
application/json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
text/json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
post:
operationId: "postMeterType"
tags:
- Configuration
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
application/json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
text/json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterTypeModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/configuration/{orgId}/clientAddress:
get:
operationId: "getClientAddress"
tags:
- Configuration
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/configuration/{orgId}/config:
get:
operationId: "getConfig"
tags:
- Configuration
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ConfigurationModel'
application/json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
text/json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
post:
operationId: "postConfig"
tags:
- Configuration
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
application/json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
text/json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
application/*+json:
schema:
$ref: '#/components/schemas/ConfigurationModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/configuration/{userId}/watchlist:
get:
operationId: "getWatchlist"
tags:
- Configuration
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/UserDeviceWatchlist'
application/json:
schema:
$ref: '#/components/schemas/UserDeviceWatchlist'
text/json:
schema:
$ref: '#/components/schemas/UserDeviceWatchlist'
/api/configuration/{userId}/{deviceId}/watchlist:
post:
operationId: "postWatchlist"
tags:
- Configuration
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/configuration/{deviceId}/{note}/watchlistnote:
post:
operationId: "postwatchlistnote"
tags:
- Configuration
parameters:
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
- name: note
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/configuration/whatsnew:
get:
operationId: "getWhatsNew"
tags:
- Configuration
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/WhatsNewModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/WhatsNewModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/WhatsNewModel'
/api/configuration/{userId}/widget:
get:
operationId: "getWidget"
tags:
- Configuration
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: isItronOrg
in: query
schema:
type: boolean
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
application/json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
text/json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
post:
operationId: "postWidget"
tags:
- Configuration
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
application/json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
text/json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
application/*+json:
schema:
$ref: '#/components/schemas/WidgetOrderModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/cpuserlog:
post:
operationId: "postcpuserlog"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CPUserLogModel'
application/json:
schema:
$ref: '#/components/schemas/CPUserLogModel'
text/json:
schema:
$ref: '#/components/schemas/CPUserLogModel'
application/*+json:
schema:
$ref: '#/components/schemas/CPUserLogModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{orgId}/consumptiontype:
get:
operationId: "getConsumptionType"
tags:
- CustomerPortal
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
application/json:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
text/json:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
/api/customerportal/{orgId}/{zip}/utilitylist:
get:
operationId: "getUtilityList"
tags:
- CustomerPortal
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: zip
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/CPUtilityListModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CPUtilityListModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/CPUtilityListModel'
/api/customerportal/accountlookup:
post:
operationId: "postaccountlookup"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/AccountLookupModel'
application/json:
schema:
$ref: '#/components/schemas/AccountLookupModel'
text/json:
schema:
$ref: '#/components/schemas/AccountLookupModel'
application/*+json:
schema:
$ref: '#/components/schemas/AccountLookupModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{accountId}/budget/{budget}:
post:
operationId: "postBudget"
tags:
- CustomerPortal
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
- name: budget
in: path
required: true
schema:
type: number
format: double
responses:
200:
description: Success
content: {}
/api/customerportal/accountcustomermapping/accountId/{accountId}/customerid/{customerUID}:
post:
operationId: "postCustomerPortal"
tags:
- CustomerPortal
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
- name: customerUID
in: path
required: true
schema:
type: string
format: uuid
responses:
200:
description: Success
content: {}
/api/customerportal/usercustomermapping/userid/{userId}/useruuid/{userUUID}/customeruuid/{customerUUID}:
post:
operationId: "postCustomerPortaluserUUID"
tags:
- CustomerPortal
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int32
- name: userUUID
in: path
required: true
schema:
type: string
format: uuid
- name: customerUUID
in: path
required: true
schema:
type: string
format: uuid
responses:
200:
description: Success
content: {}
/api/customerportal/customerdetails:
post:
operationId: "postcustomerdetails"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerInfoModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerInfoModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerInfoModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerInfoModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/createuser:
post:
operationId: "postcreateuser"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CreateUserModel'
application/json:
schema:
$ref: '#/components/schemas/CreateUserModel'
text/json:
schema:
$ref: '#/components/schemas/CreateUserModel'
application/*+json:
schema:
$ref: '#/components/schemas/CreateUserModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/createcpuser:
post:
operationId: "postcreatecpuser"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerPortalUserModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerPortalUserModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerPortalUserModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerPortalUserModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/sso-login:
get:
operationId: "getSsoLogin"
tags:
- CustomerPortal
responses:
200:
description: Success
content: {}
/api/customerportal/login:
post:
operationId: "postlogin"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/LoginModel'
application/json:
schema:
$ref: '#/components/schemas/LoginModel'
text/json:
schema:
$ref: '#/components/schemas/LoginModel'
application/*+json:
schema:
$ref: '#/components/schemas/LoginModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{orgUnitId}/{accountId}/userinfo:
get:
operationId: "getUserInfo"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{accountId}/usercontactmethods:
get:
operationId: "getUserContactMethods"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{accountId}/usercontactmethod:
post:
operationId: "postusercontactmethod"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: string
- name: accountId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/submitdisconnectinfo:
post:
operationId: "postsubmitdisconnectinfo"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/sendsupportmessage:
post:
operationId: "postsendsupportmessage"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
application/json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
text/json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
application/*+json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/reportoutage:
operationId: "postreportoutage"
post:
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
application/json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
text/json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
application/*+json:
schema:
$ref: '#/components/schemas/SupportMessageModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{accountId}/usercontactmethod:
put:
operationId: "putusercontactmethod"
tags:
- CustomerPortal
parameters:
- name: accountId
in: path
required: true
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerMethodsModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{orgUnitId}/{accountId}/{DbID}/usercontactmethod:
delete:
operationId: "deleteusercontactmethod"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
- name: DbID
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/alarms:
post:
operationId: "postAlarms"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerMeterAlarmModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerMeterAlarmModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerMeterAlarmModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerMeterAlarmModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{accountId}/deletealarms:
post:
operationId: "postdeletealarms"
tags:
- CustomerPortal
parameters:
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeleteModel'
application/json:
schema:
$ref: '#/components/schemas/DeleteModel'
text/json:
schema:
$ref: '#/components/schemas/DeleteModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeleteModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/{orgUnitId}/{deviceId}/{alarmType}/alarms:
get:
operationId: "getAlarms"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
- name: alarmType
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{deviceId}/allalarms:
get:
operationId: "getAllAlarms"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{deviceId}/billingperiod:
get:
operationId: "getBillingPeriod"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{deviceId}/estimatedbilling:
get:
operationId: "getEstimatedBilling"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
- name: date
in: query
schema:
type: string
format: date-time
- name: currentBill
in: query
schema:
type: boolean
default: false
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{deviceId}/previousmonthbilling:
get:
operationId: "getPreviousMonthBilling"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{deviceId}/alarmhistory:
get:
operationId: "getAlarmHistory"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/{orgUnitId}/{accountId}/creditletter:
get:
operationId: "getCreditLetter"
tags:
- CustomerPortal
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: accountId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/customervalveturn:
post:
operationId: "postcustomervalveturn"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerValveTurnModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerValveTurnModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerValveTurnModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerValveTurnModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/customerportal/valveschedules:
get:
operationId: "getValvesSchedules"
tags:
- CustomerPortal
parameters:
- name: deviceId
in: query
schema:
type: integer
format: int32
- name: isOpenCommand
in: query
schema:
type: boolean
- name: date
in: query
schema:
type: string
format: date-time
responses:
200:
description: Success
content: {}
/api/customerportal/scheduledvalvecommands:
get:
operationId: "getScheduledValvesCommands"
tags:
- CustomerPortal
parameters:
- name: deviceId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/customerportal/cancelcommand:
post:
operationId: "postcancelcommand"
tags:
- CustomerPortal
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/CustomerCommandCancelModel'
application/json:
schema:
$ref: '#/components/schemas/CustomerCommandCancelModel'
text/json:
schema:
$ref: '#/components/schemas/CustomerCommandCancelModel'
application/*+json:
schema:
$ref: '#/components/schemas/CustomerCommandCancelModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/health/ping:
get:
operationId: "getPing"
tags:
- Health
responses:
200:
description: Success
content: {}
/api/images/{orgId}:
post:
operationId: "postimages"
tags:
- Image
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/SaveImageModel'
application/json:
schema:
$ref: '#/components/schemas/SaveImageModel'
text/json:
schema:
$ref: '#/components/schemas/SaveImageModel'
application/*+json:
schema:
$ref: '#/components/schemas/SaveImageModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/itron/{orgId}/alarms/{alarm}:
get:
operationId: "getAlarmsById"
tags:
- ITRON
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: alarm
in: path
required: true
schema:
type: string
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
type: integer
format: int32
application/json:
schema:
type: array
items:
type: integer
format: int32
text/json:
schema:
type: array
items:
type: integer
format: int32
/api/itron/{orgId}/alarms:
get:
operationId: "getAlarms"
tags:
- ITRON
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ITRONAlarmModel'
application/json:
schema:
$ref: '#/components/schemas/ITRONAlarmModel'
text/json:
schema:
$ref: '#/components/schemas/ITRONAlarmModel'
/api/itron/{orgId}/isitronorg:
get:
operationId: "getIsItronOrg"
tags:
- ITRON
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
type: boolean
application/json:
schema:
type: boolean
text/json:
schema:
type: boolean
/api/meters/{orgId}/meteranalytics:
get:
operationId: "getMeterAnalytics"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/BillingReadingModel'
application/json:
schema:
$ref: '#/components/schemas/BillingReadingModel'
text/json:
schema:
$ref: '#/components/schemas/BillingReadingModel'
/api/meters/{orgId}/validmeters:
get:
operationId: "getValidMeters"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
/api/meters/{orgId}/meters:
get:
operationId: "getMeters"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
/api/meters/{orgId}/searchmeters:
get:
operationId: "getSearchMeters"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: search
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/BillingSearchModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BillingSearchModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/BillingSearchModel'
/api/meters/{orgId}/invalidmeters:
get:
operationId: "getInvalidMeters"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadsDetailsModel'
/api/meters/{orgId}/batteryalarm:
get:
operationId: "getBatteryAlarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/tampermeters:
get:
operationId: "getTamperMeters"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/flowalarms:
get:
operationId: "getFlowAlarms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/MetersAlarmModel'
application/json:
schema:
$ref: '#/components/schemas/MetersAlarmModel'
text/json:
schema:
$ref: '#/components/schemas/MetersAlarmModel'
/api/meters/{orgId}/backflowalarm:
get:
operationId: "getBackFlowAlarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/wakeupfailures:
get:
operationId: "getWakeupFailures"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: consecutiveDays
in: query
schema:
type: integer
format: int32
- name: startTime
in: query
schema:
type: string
format: date-time
- name: endTime
in: query
schema:
type: string
format: date-time
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
type: integer
format: int32
application/json:
schema:
type: array
items:
type: integer
format: int32
text/json:
schema:
type: array
items:
type: integer
format: int32
/api/meters/{orgId}/excessalarm:
get:
operationId: "getExcessAlarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: waterConsumptionBuffer
in: query
schema:
type: integer
format: int32
default: -1
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
- name: continuousExcessiveHour
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/consumptionafterclose:
get:
operationId: "getConsumptionAfterClose"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/continuousalarm:
get:
operationId: "getContinuousAlarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
- name: hourlyConsumption
in: query
schema:
type: number
format: double
default: -1.0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/metergraphinfo:
get:
operationId: "getMeterInfo"
tags:
- Meters
parameters:
- name: deviceId
in: query
schema:
type: integer
format: int32
- name: start
in: query
schema:
type: string
format: date-time
- name: end
in: query
schema:
type: string
format: date-time
- name: type
in: query
schema:
type: string
- name: isCelcius
in: query
schema:
type: boolean
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/MultiAxisChartData'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MultiAxisChartData'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/MultiAxisChartData'
/api/meters/{orgId}/noalarm:
get:
operationId: "getNoAlarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgUnitId}/{groupId}/dmawaterconsumption:
get:
operationId: "getdmawaterconsumption"
tags:
- Meters
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: path
required: true
schema:
type: integer
format: int32
- name: startTime
in: query
schema:
type: string
format: date-time
- name: intervalTime
in: query
schema:
type: integer
format: int32
- name: intervalType
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/DMAWaterLossModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAWaterLossModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAWaterLossModel'
/api/meters/{orgUnitId}/{groupId}/dmamap:
get:
operationId: "getdmamap"
tags:
- Meters
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: path
required: true
schema:
type: integer
format: int32
- name: startTime
in: query
schema:
type: string
format: date-time
- name: intervalType
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/DMAMapModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAMapModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAMapModel'
/api/meters/{orgUnitId}/{groupId}/dmawaterconsumptiondetails:
get:
operationId: "dmawaterconsumptiondetails"
tags:
- Meters
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: path
required: true
schema:
type: integer
format: int32
- name: startTime
in: query
schema:
type: string
format: date-time
- name: intervalType
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
format: int32
default: 0
- name: pagesize
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupDeviceConsumptionModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupDeviceConsumptionModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupDeviceConsumptionModel'
/api/meters/{orgUnitId}/dmagroups:
get:
operationId: "getdmagroups"
tags:
- Meters
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: startTime
in: query
schema:
type: string
format: date-time
- name: intervalTime
in: query
schema:
type: integer
format: int32
- name: intervalType
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupUsageModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupUsageModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/DMAGroupUsageModel'
/api/meters/{orgId}/inactivealarm:
get:
operationId: "getinactivealarm"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: hours
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content:
text/plain:
schema:
type: integer
format: int64
application/json:
schema:
type: integer
format: int64
text/json:
schema:
type: integer
format: int64
x-codegen-request-body-name: body
/api/meters/{orgId}/usagecomparison:
post:
operationId: "postusagecomparison"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ComparisonModel'
application/json:
schema:
$ref: '#/components/schemas/ComparisonModel'
text/json:
schema:
$ref: '#/components/schemas/ComparisonModel'
application/*+json:
schema:
$ref: '#/components/schemas/ComparisonModel'
required: false
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
application/json:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
text/json:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
x-codegen-request-body-name: body
/api/meters/{orgId}/usage:
post:
operationId: "postusage"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ConsumptionModel'
application/json:
schema:
$ref: '#/components/schemas/ConsumptionModel'
text/json:
schema:
$ref: '#/components/schemas/ConsumptionModel'
application/*+json:
schema:
$ref: '#/components/schemas/ConsumptionModel'
required: false
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
application/json:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
text/json:
schema:
$ref: '#/components/schemas/WaterConsumptionModel'
x-codegen-request-body-name: body
/api/meters/{orgId}/toptenusage:
post:
operationId: "posttoptenusage"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/TopTenConsumptionModel'
application/json:
schema:
$ref: '#/components/schemas/TopTenConsumptionModel'
text/json:
schema:
$ref: '#/components/schemas/TopTenConsumptionModel'
application/*+json:
schema:
$ref: '#/components/schemas/TopTenConsumptionModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/device:
post:
operationId: "postDeviceByOrgId"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: meterId
in: query
schema:
type: string
- name: premiseId
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgID}/generatereport:
post:
operationId: "postgeneratereport"
tags:
- Meters
parameters:
- name: orgID
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: orgName
in: query
schema:
type: string
- name: pastReadingDate
in: query
schema:
type: string
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/BillingConfigModel'
application/json:
schema:
$ref: '#/components/schemas/BillingConfigModel'
text/json:
schema:
$ref: '#/components/schemas/BillingConfigModel'
application/*+json:
schema:
$ref: '#/components/schemas/BillingConfigModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgID}/{deviceId}/devicealarmfrequency:
get:
operationId: "getdevicealarmfrequency"
tags:
- Meters
parameters:
- name: orgID
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgID}/{deviceId}/devicealarmfrequencywithrange:
get:
operationId: "getdevicealarmfrequencywithrange"
tags:
- Meters
parameters:
- name: orgID
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgID}/{daysBack}/orgalarmfrequency:
get:
operationId: "getorgalarmfrequency"
tags:
- Meters
parameters:
- name: orgID
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
- name: daysBack
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/billingreads:
get:
operationId: "getBillingreads"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/billingreport:
get:
operationId: "getbillingreport"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/{fileName}/downloadfile:
get:
operationId: "getdownloadfile"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: fileName
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/{deviceId}/Alarms:
get:
operationId: "getAlarmsByDeviceId"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/Alarms:
get:
operationId: "getAlarms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: userId
in: query
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: deviceId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content: {}
post:
operationId: "postAlarms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: userId
in: query
schema:
type: integer
format: int32
- name: frequency
in: query
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: email
in: query
schema:
type: string
- name: text
in: query
schema:
type: string
- name: deviceId
in: query
schema:
type: integer
format: int32
default: 0
requestBody:
content:
application/json-patch+json:
schema:
type: array
items:
type: integer
format: int32
application/json:
schema:
type: array
items:
type: integer
format: int32
text/json:
schema:
type: array
items:
type: integer
format: int32
application/*+json:
schema:
type: array
items:
type: integer
format: int32
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/AddMeterReading:
post:
operationId: "postAddMeterReading"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/AddNote:
operationId: "postAddNote"
post:
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/AddMeterNote:
post:
operationId: "postAddMeterNote"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
text/json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterReadingModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/GetMetersByPremise:
get:
operationId: "getMetersByPremise"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: premise
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/GetSerialNumbersByPremise:
get:
operationId: "getSerialNumbersByPremise"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: premise
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{deviceId}/{type}/flowpressure:
get:
operationId: "getFlowPressure"
tags:
- Meters
parameters:
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
- name: type
in: path
required: true
schema:
type: integer
format: int32
- name: start
in: query
schema:
type: string
format: date-time
- name: end
in: query
schema:
type: string
format: date-time
- name: isMinPressure
in: query
schema:
type: boolean
default: true
responses:
200:
description: Success
content: {}
/api/meters/{deviceId}/{type}/flowtemp:
get:
operationId: "getflowtemp"
tags:
- Meters
parameters:
- name: deviceId
in: path
required: true
schema:
type: integer
format: int32
- name: type
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/images:
post:
operationId: "getimages"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterImageModel'
application/json:
schema:
$ref: '#/components/schemas/MeterImageModel'
text/json:
schema:
$ref: '#/components/schemas/MeterImageModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterImageModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/location:
post:
operationId: "getLocation"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterLocationModel'
application/json:
schema:
$ref: '#/components/schemas/MeterLocationModel'
text/json:
schema:
$ref: '#/components/schemas/MeterLocationModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterLocationModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/metadata:
post:
operationId: "getMetaData"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/MeterMetadataModel'
application/json:
schema:
$ref: '#/components/schemas/MeterMetadataModel'
text/json:
schema:
$ref: '#/components/schemas/MeterMetadataModel'
application/*+json:
schema:
$ref: '#/components/schemas/MeterMetadataModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/changeserial:
post:
operationId: "getchangeserial"
tags:
- Meters
parameters:
- name: oldId
in: query
schema:
type: string
- name: newId
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/position:
post:
operationId: "getposition"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/wakeup:
post:
operationId: "getwakeup"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/interface:
post:
operationId: "getinterface"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/meterreading:
post:
operationId: "getmeterreading"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/iccid:
post:
operationId: "postgeticcid"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceWarehouseModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/AssignMeter/{serial}:
post:
operationId: "postMeterBySerial"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: serial
in: path
required: true
schema:
type: string
- name: meter
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/AssignPremise/{serial}:
post:
operationId: "postAssignPremise"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: serial
in: path
required: true
schema:
type: string
- name: locationId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/premise/{premise}:
get:
operationId: "getPremise"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: premise
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/premisebymeterid/{meterid}:
get:
operationId: "getpremisebymeterid"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: meterid
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{orgId}/premisebyserialnumber/{serialNumber}:
get:
operationId: "getpremisebyserialnumber"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: serialNumber
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/itron:
post:
operationId: "getitron"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/ItronCreationModel'
application/json:
schema:
$ref: '#/components/schemas/ItronCreationModel'
text/json:
schema:
$ref: '#/components/schemas/ItronCreationModel'
application/*+json:
schema:
$ref: '#/components/schemas/ItronCreationModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/skippedinstall:
post:
operationId: "getskippedinstall"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/SkippedInstallModel'
application/json:
schema:
$ref: '#/components/schemas/SkippedInstallModel'
text/json:
schema:
$ref: '#/components/schemas/SkippedInstallModel'
application/*+json:
schema:
$ref: '#/components/schemas/SkippedInstallModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{serialNumber}/itron:
get:
operationId: "getitron"
tags:
- Meters
parameters:
- name: serialNumber
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{serialNumber}/orglookup:
get:
operationId: "getMeterByOrglookup"
tags:
- Meters
parameters:
- name: serialNumber
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/{meterId}/serialNumber:
get:
operationId: "getMeterBySerialNumber"
tags:
- Meters
parameters:
- name: meterId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/meters/uploadmeterreads:
post:
operationId: "uploadmeterreads"
tags:
- Meters
parameters:
- name: orgId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/meters/devicedebugginglogs:
post:
operationId: "getdevicedebugginglogs"
tags:
- Meters
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DeviceDebuggingLogModel'
application/json:
schema:
$ref: '#/components/schemas/DeviceDebuggingLogModel'
text/json:
schema:
$ref: '#/components/schemas/DeviceDebuggingLogModel'
application/*+json:
schema:
$ref: '#/components/schemas/DeviceDebuggingLogModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/meters/{orgId}/EndpointComms:
get:
operationId: "getEndpointComms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
- name: onlyMeters
in: query
schema:
type: boolean
default: false
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/EndpointCommsModel'
application/json:
schema:
$ref: '#/components/schemas/EndpointCommsModel'
text/json:
schema:
$ref: '#/components/schemas/EndpointCommsModel'
/api/meters/{orgId}/validEndpointComms:
get:
operationId: "getValidEndpointComms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
- name: onlyMeters
in: query
schema:
type: boolean
default: false
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
application/json:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
text/json:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
/api/meters/{orgId}/invalidEndpointComms:
get:
operationId: "getInValidEndpointComms"
tags:
- Meters
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
- name: pastDays
in: query
schema:
type: integer
format: int32
default: 0
- name: onlyMeters
in: query
schema:
type: boolean
default: false
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
application/json:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
text/json:
schema:
$ref: '#/components/schemas/CommsDetailsModel'
/api/org/{orgId}/mmcis:
post:
operationId: "postMmcis"
tags:
- Organization
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/M2mCisRequestModel'
application/json:
schema:
$ref: '#/components/schemas/M2mCisRequestModel'
text/json:
schema:
$ref: '#/components/schemas/M2mCisRequestModel'
application/*+json:
schema:
$ref: '#/components/schemas/M2mCisRequestModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/org/{orgId}/consumptiontype:
get:
operationId: "getConsumptiontype"
tags:
- Organization
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
application/json:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
text/json:
schema:
$ref: '#/components/schemas/OrgUnitConsumptionTypeModel'
/api/org/{orgId}/groups:
get:
operationId: "getOrgGroups"
tags:
- Organization
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/GroupModel'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/GroupModel'
/api/org/{groupId}/districtmeters:
get:
operationId: "getDistrictMeters"
tags:
- Organization
parameters:
- name: groupId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
type: integer
format: int32
application/json:
schema:
type: array
items:
type: integer
format: int32
text/json:
schema:
type: array
items:
type: integer
format: int32
post:
operationId: "postDistrictMeters"
tags:
- Organization
parameters:
- name: groupId
in: path
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/DistrictIdModel'
application/json:
schema:
$ref: '#/components/schemas/DistrictIdModel'
text/json:
schema:
$ref: '#/components/schemas/DistrictIdModel'
application/*+json:
schema:
$ref: '#/components/schemas/DistrictIdModel'
required: false
responses:
200:
description: Success
content:
text/plain:
schema:
type: boolean
application/json:
schema:
type: boolean
text/json:
schema:
type: boolean
x-codegen-request-body-name: body
/api/org/{orgId}/offlinepremise:
get:
operationId: "getofflinepremise"
tags:
- Organization
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: pageSize
in: query
schema:
type: integer
format: int32
- name: filter
in: query
schema:
type: string
responses:
200:
description: Success
content: {}
/api/org/{orgUnitId}/{orgName}/billing:
get:
operationId: "getbilling"
tags:
- Organization
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: orgName
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/org/{orgUnitId}/metersizeresolution:
get:
operationId: "getmetersizeresolution"
tags:
- Organization
parameters:
- name: orgUnitId
in: path
required: true
schema:
type: integer
format: int32
- name: isBillingResolution
in: query
schema:
type: boolean
responses:
200:
description: Success
content: {}
/api/external/reads:
get:
operationId: "getreads"
tags:
- ThirdParty
parameters:
- name: serialNumber
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
format: int32
default: 0
- name: pageSize
in: query
schema:
type: integer
format: int32
default: 2500
- name: hours
in: query
schema:
type: integer
format: int32
default: 72
responses:
200:
description: Success
content: {}
/api/external/billingreads:
get:
operationId: "getbillingreads"
tags:
- ThirdParty
parameters:
- name: serialNumber
in: query
schema:
type: string
- name: groupName
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
format: int32
default: 0
- name: pageSize
in: query
schema:
type: integer
format: int32
default: 2500
responses:
200:
description: Success
content: {}
/api/users/login/{user}/{password}:
get:
operationId: "getUserPassword"
tags:
- Users
parameters:
- name: user
in: path
required: true
schema:
type: string
- name: password
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/users/principal:
get:
operationId: "getUsersPrincipal"
tags:
- Users
responses:
200:
description: Success
content: {}
/api/users/auth:
post:
operationId: "postAuth"
tags:
- Users
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/UserLoginModel'
application/json:
schema:
$ref: '#/components/schemas/UserLoginModel'
text/json:
schema:
$ref: '#/components/schemas/UserLoginModel'
application/*+json:
schema:
$ref: '#/components/schemas/UserLoginModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/users/lookup:
post:
operationId: "usersLookup"
tags:
- Users
requestBody:
content:
application/json-patch+json:
schema:
$ref: '#/components/schemas/LookupUsernameModel'
application/json:
schema:
$ref: '#/components/schemas/LookupUsernameModel'
text/json:
schema:
$ref: '#/components/schemas/LookupUsernameModel'
application/*+json:
schema:
$ref: '#/components/schemas/LookupUsernameModel'
required: false
responses:
200:
description: Success
content: {}
x-codegen-request-body-name: body
/api/users/sso:
get:
operationId: "getSso"
tags:
- Users
responses:
200:
description: Success
content: {}
/api/users/signOut/{token}:
post:
operationId: "signOutToken"
tags:
- Users
parameters:
- name: token
in: path
required: true
schema:
type: string
format: uuid
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/valvewidget:
get:
operationId: "valvewidget"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
default: 0
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/openvalves:
get:
operationId: "getopenvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/closedvalves:
get:
operationId: "getclosedvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/halfvalves:
get:
operationId: "gethalfvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/queuedvalves:
get:
operationId: "getqueuedvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/failedconfirmationvalves:
get:
operationId: "getfailedconfirmationvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
- name: groupId
in: query
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{orgId}/orgvalves:
get:
operationId: "getorgvalves"
tags:
- Valve
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{requestid}/requeststatus:
get:
operationId: "getrequeststatus"
tags:
- Valve
parameters:
- name: requestid
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/RequestInfo'
application/json:
schema:
$ref: '#/components/schemas/RequestInfo'
text/json:
schema:
$ref: '#/components/schemas/RequestInfo'
/api/valves/{requestid}/cancelrequest:
post:
operationId: "getcancelrequest"
tags:
- Valve
parameters:
- name: requestid
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/valves/{valveid}/currentstatebyvalveid:
get:
operationId: "getcurrentstatebyvalveid"
tags:
- Valve
parameters:
- name: valveid
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content: {}
/api/valves/{setflowid}/currentstatebysetflowid:
get:
operationId: "getcurrentstatebysetflowid"
tags:
- Valve
parameters:
- name: setflowid
in: path
required: true
schema:
type: integer
format: int32
responses:
200:
description: Success
content: {}
/api/valves/{valveid}/history:
get:
operationId: "gethistory"
tags:
- Valve
parameters:
- name: valveid
in: path
required: true
schema:
type: string
- name: startdate
in: query
schema:
type: string
- name: enddate
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/RequestInfo'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RequestInfo'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/RequestInfo'
/api/valves:
get:
operationId: "getValves"
tags:
- Valve
parameters:
- name: premiseId
in: query
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
/api/valves/{wellknowntext}/searchboundedbox:
get:
operationId: "getsearchboundedbox"
tags:
- Valve
parameters:
- name: wkt
in: query
schema:
type: string
- name: wellknowntext
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApiValveReference'
/api/valves/{valveId}/events:
get:
operationId: "getValuesEvents"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ValveEventDTO'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveEventDTO'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveEventDTO'
/api/valves/{valveId}/images:
get:
operationId: "getValuesImages"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ValveImageDTO'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveImageDTO'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveImageDTO'
/api/valves/{valveId}/notes:
get:
operationId: "getValveNotes"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/ValveNoteDTO'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveNoteDTO'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/ValveNoteDTO'
/api/valves/{valveId}/valvecommands:
get:
operationId: "getValveCommands"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/ApiGatewayValveCommandDTO'
application/json:
schema:
$ref: '#/components/schemas/ApiGatewayValveCommandDTO'
text/json:
schema:
$ref: '#/components/schemas/ApiGatewayValveCommandDTO'
/api/valves/{valveId}/leak:
get:
operationId: "getValveLeak"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
$ref: '#/components/schemas/LeakDetectEventDTO'
application/json:
schema:
$ref: '#/components/schemas/LeakDetectEventDTO'
text/json:
schema:
$ref: '#/components/schemas/LeakDetectEventDTO'
/api/valves/{valveId}/alerts:
get:
operationId: "getValveAlerts"
tags:
- Valve
parameters:
- name: valveId
in: path
required: true
schema:
type: string
responses:
200:
description: Success
content:
text/plain:
schema:
type: array
items:
$ref: '#/components/schemas/MeterAlert'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MeterAlert'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/MeterAlert'
components:
schemas:
AccountLookupModel:
type: object
properties:
accountNumber:
type: string
webAccessCode:
type: string
email:
type: string
firstName:
type: string
lastName:
type: string
lastFourSSN:
type: string
zipcode:
type: integer
format: int32
ApiGatewayValveCommandDTO:
type: object
ApiValveReference:
type: object
Assembly:
type: object
properties:
definedTypes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/TypeInfo'
exportedTypes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Type'
codeBase:
type: string
readOnly: true
entryPoint:
$ref: '#/components/schemas/MethodInfo'
fullName:
type: string
readOnly: true
imageRuntimeVersion:
type: string
readOnly: true
isDynamic:
type: boolean
readOnly: true
location:
type: string
readOnly: true
reflectionOnly:
type: boolean
readOnly: true
isCollectible:
type: boolean
readOnly: true
isFullyTrusted:
type: boolean
readOnly: true
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
escapedCodeBase:
type: string
readOnly: true
manifestModule:
$ref: '#/components/schemas/Module'
modules:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Module'
globalAssemblyCache:
type: boolean
readOnly: true
hostContext:
type: integer
format: int64
readOnly: true
securityRuleSet:
$ref: '#/components/schemas/SecurityRuleSet'
Attribute:
type: object
properties:
typeId:
type: object
readOnly: true
BillingConfigModel:
type: object
properties:
altEmailAddress:
type: string
billingFileFormat:
type: string
billingPeriodLength:
type: integer
format: int32
billingTransportMethod:
type: string
ftpInfo:
type: string
emailAddress:
type: string
webAPI_Info:
type: string
billScheduler:
type: integer
format: int32
estimatorXStartDate:
type: string
format: date-time
estimatorXEndDate:
type: string
format: date-time
estimatorY:
type: integer
format: int32
ftpUsername:
type: string
ftpPassword:
type: string
useEstimator:
type: boolean
groupIds:
type: array
items:
type: integer
format: int32
BillingMeterDetailsModel:
type: object
properties:
name:
type: string
meterReads:
type: integer
format: int64
meterScore:
type: number
format: double
BillingReadingModel:
type: object
properties:
validMeters:
$ref: '#/components/schemas/BillingMeterDetailsModel'
invalidMeters:
$ref: '#/components/schemas/BillingMeterDetailsModel'
BillingSearchModel:
type: object
properties:
seTflowID:
type: integer
format: int32
accountNumber:
type: string
capturedReading:
type: string
billingReading:
type: number
format: double
readDate:
type: string
format: date-time
address:
type: string
premiseID:
type: string
customerName:
type: string
BizRuleAspect:
type: object
BLMethodArgumentInfo:
type: object
properties:
name:
type: string
value:
$ref: '#/components/schemas/ObjectLazy'
type:
$ref: '#/components/schemas/Type'
longTypeName:
type: string
readOnly: true
shortTypeName:
type: string
readOnly: true
BLMethodCallInfo:
type: object
properties:
attributes:
type: array
items:
$ref: '#/components/schemas/Attribute'
method:
$ref: '#/components/schemas/MethodInfo'
name:
type: string
returnType:
type: string
arguments:
type: array
items:
$ref: '#/components/schemas/BLMethodArgumentInfo'
CallingConventions:
type: integer
format: int32
enum:
- 1
- 2
- 3
- 32
- 64
CommsDetailsModel:
type: object
properties:
deviceIds:
type: array
items:
type: integer
format: int32
ComparisonModel:
type: object
properties:
groupId:
type: integer
format: int32
deviceId:
type: integer
format: int32
days:
type: integer
format: int32
hours:
type: integer
format: int32
startTime:
type: string
format: date-time
ConfigurationModel:
type: object
properties:
orgUnitId:
type: integer
format: int32
billingTimeFrameDefault:
type: integer
format: int32
billingFileFormat:
type: string
billingPeriodLength:
type: integer
format: int32
billingTransportMethod:
type: string
ftpInfo:
type: string
emailAddress:
type: string
altEmailAddress:
type: string
webApiInfo:
type: string
billScheduler:
type: integer
format: int32
estimatorXStartDate:
type: string
format: date-time
estimatorY:
type: integer
format: int32
useEstimator:
type: boolean
estimatorXEndDate:
type: string
format: date-time
waterUsageGroupDefault:
type: integer
format: int32
waterUsageTimeFrameDefault:
type: integer
format: int32
ftpUsername:
type: string
ftpPassword:
type: string
consumptionBuffer:
type: integer
format: int32
excessiveHours:
type: integer
format: int32
continuousExcessiveHours:
type: integer
format: int32
continuousHours:
type: integer
format: int32
hourlyConsumption:
type: integer
format: int32
hourlyConsumptionDecimal:
type: number
format: double
noFlowHours:
type: integer
format: int32
inactiveHours:
type: integer
format: int32
backFlowHours:
type: integer
format: int32
validReadBillingTimeframe:
type: integer
format: int32
batteryThreshold:
type: integer
format: int32
endpointCommunication:
type: integer
format: int32
initialBillingDate:
type: string
format: date-time
billingInterface:
type: integer
format: int32
ConnectionState:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 4
- 8
- 16
ConstructorInfo:
type: object
properties:
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
attributes:
$ref: '#/components/schemas/MethodAttributes'
methodImplementationFlags:
$ref: '#/components/schemas/MethodImplAttributes'
callingConvention:
$ref: '#/components/schemas/CallingConventions'
isAbstract:
type: boolean
readOnly: true
isConstructor:
type: boolean
readOnly: true
isFinal:
type: boolean
readOnly: true
isHideBySig:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isStatic:
type: boolean
readOnly: true
isVirtual:
type: boolean
readOnly: true
isAssembly:
type: boolean
readOnly: true
isFamily:
type: boolean
readOnly: true
isFamilyAndAssembly:
type: boolean
readOnly: true
isFamilyOrAssembly:
type: boolean
readOnly: true
isPrivate:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isConstructedGenericMethod:
type: boolean
readOnly: true
isGenericMethod:
type: boolean
readOnly: true
isGenericMethodDefinition:
type: boolean
readOnly: true
containsGenericParameters:
type: boolean
readOnly: true
methodHandle:
$ref: '#/components/schemas/RuntimeMethodHandle'
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
ConsumptionModel:
type: object
properties:
groupId:
type: integer
format: int32
deviceId:
type: integer
format: int32
days:
type: integer
format: int32
hours:
type: integer
format: int32
months:
type: integer
format: int32
customDate:
$ref: '#/components/schemas/CustomDateEnum'
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
CPUserLogModel:
type: object
properties:
orgId:
type: integer
format: int32
eventType:
type: string
ipAddress:
type: string
userIdGuid:
type: string
format: uuid
CPUtilityListModel:
type: object
properties:
id:
type: integer
format: int32
orgID:
type: integer
format: int32
name:
type: string
phone:
type: string
email:
type: string
zipCode:
type: string
dateCreated:
type: string
format: date-time
phoneExt:
type: string
CreateUserModel:
type: object
properties:
firstName:
type: string
lastName:
type: string
userName:
type: string
password:
type: string
email:
type: string
orgUnitId:
type: integer
format: int32
accountId:
type: string
CustomAttributeData:
type: object
properties:
attributeType:
$ref: '#/components/schemas/Type'
constructor:
$ref: '#/components/schemas/ConstructorInfo'
constructorArguments:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeTypedArgument'
namedArguments:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeNamedArgument'
CustomAttributeNamedArgument:
type: object
properties:
memberInfo:
$ref: '#/components/schemas/MemberInfo'
typedValue:
$ref: '#/components/schemas/CustomAttributeTypedArgument'
memberName:
type: string
readOnly: true
isField:
type: boolean
readOnly: true
CustomAttributeTypedArgument:
type: object
properties:
argumentType:
$ref: '#/components/schemas/Type'
value:
type: object
readOnly: true
CustomDateEnum:
type: integer
format: int32
enum:
- 1
- 2
- 3
CustomerCommandCancelModel:
type: object
properties:
commandId:
type: integer
format: int32
date:
type: string
CustomerInfoModel:
type: object
properties:
accountId:
type: integer
format: int32
email:
type: string
firstName:
type: string
lastName:
type: string
CustomerMeterAlarmModel:
type: object
properties:
userId:
type: string
format: uuid
deviceId:
type: integer
format: int32
contactInfoText:
type: string
contactInfoEmail:
type: string
accountId:
type: integer
format: int32
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
alarmTypeId:
type: integer
format: int32
buffer:
type: number
format: double
CustomerMethodsModel:
type: object
properties:
email:
type: string
phoneNumber:
type: string
contactMethod:
type: string
orgUnitId:
type: integer
format: int32
accountId:
type: integer
format: int32
id:
type: integer
format: int32
phoneNumberType:
type: string
emailType:
type: string
disconnectDate:
type: string
CustomerPortalUserModel:
type: object
properties:
accountId:
type: integer
format: int32
username:
type: string
password:
type: string
CustomerValveTurnModel:
type: object
properties:
deviceId:
type: integer
format: int32
email:
type: string
sms:
type: string
scheduledDate:
type: string
format: date-time
isOpenCommand:
type: boolean
DeleteModel:
type: object
properties:
orgUnitId:
type: integer
format: int32
accountId:
type: integer
format: int32
alarmTypeId:
type: integer
format: int32
removeEmail:
type: boolean
removeText:
type: boolean
DeviceDebuggingLogModel:
type: object
properties:
sn:
type: string
timeStamp:
type: string
format: date-time
debugLevel:
type: string
userID:
type: integer
format: int32
content:
type: string
DeviceWarehouseModel:
type: object
properties:
serialNumber:
type: string
totalTurns:
type: integer
format: int32
interface:
type: integer
format: int32
valvePosition:
type: integer
format: int32
rssi:
type: integer
format: int32
batteryVoltage:
type: number
format: double
wakeUp:
type: integer
format: int32
reading:
type: string
iccid:
type: string
ertid:
type: string
deviceType:
type: integer
format: int32
channel:
type: integer
format: int32
DeviceWatchlistModel:
type: object
properties:
id:
type: integer
format: int32
deviceID:
type: integer
format: int32
lastHeardFromDate:
type: string
alarmType:
type: string
alarmFrequency:
type: integer
format: int32
notes:
type: string
userID:
type: integer
format: int32
orgUnitID:
type: integer
format: int32
serialNumber:
type: string
customerAcctNumber:
type: string
DistrictIdModel:
type: object
properties:
districtIds:
type: array
items:
type: integer
format: int32
DMAGroupDeviceConsumptionModel:
type: object
properties:
deviceId:
type: integer
format: int32
meter:
type: string
percentage:
type: number
format: double
consumption:
type: integer
format: int32
pages:
type: integer
format: int32
deviceName:
type: string
stx:
type: number
format: double
sty:
type: number
format: double
serialNumber:
type: string
deviceState:
type: string
installedDate:
type: string
format: date-time
firstSeen:
type: string
format: date-time
manufacturer:
type: string
model:
type: string
isDMA:
type: boolean
DMAGroupUsageModel:
type: object
properties:
metercountWithReadings:
type: integer
format: int32
nonDistrictCount:
type: integer
format: int32
districtCount:
type: integer
format: int32
name:
type: string
groupId:
type: integer
format: int32
districtConsumption:
type: number
format: double
nonDistrictConsumption:
type: number
format: double
loss:
type: number
format: double
DMAMapModel:
type: object
properties:
meter:
type: string
state:
type: string
installedDate:
type: string
format: date-time
manufacturer:
type: string
model:
type: string
serialNumber:
type: string
geoLocation:
type: string
isDistrictMeter:
type: boolean
DMAWaterLossModel:
type: object
properties:
interval:
type: string
input:
type: number
format: double
output:
type: number
format: double
EndpointCommsDetailModel:
type: object
properties:
name:
type: string
comms:
type: integer
format: int64
score:
type: number
format: double
EndpointCommsModel:
type: object
properties:
validComms:
$ref: '#/components/schemas/EndpointCommsDetailModel'
invalidComms:
$ref: '#/components/schemas/EndpointCommsDetailModel'
EventAttributes:
type: integer
format: int32
enum:
- 0
- 512
- 1024
EventInfo:
type: object
properties:
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
attributes:
$ref: '#/components/schemas/EventAttributes'
isSpecialName:
type: boolean
readOnly: true
addMethod:
$ref: '#/components/schemas/MethodInfo'
removeMethod:
$ref: '#/components/schemas/MethodInfo'
raiseMethod:
$ref: '#/components/schemas/MethodInfo'
isMulticast:
type: boolean
readOnly: true
eventHandlerType:
$ref: '#/components/schemas/Type'
Exception:
type: object
properties:
targetSite:
$ref: '#/components/schemas/MethodBase'
message:
type: string
readOnly: true
data:
type: object
additionalProperties:
type: object
readOnly: true
innerException:
$ref: '#/components/schemas/Exception'
helpLink:
type: string
source:
type: string
hResult:
type: integer
format: int32
stackTrace:
type: string
readOnly: true
FieldAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 4096
- 8192
- 32768
- 38144
FieldInfo:
type: object
properties:
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
attributes:
$ref: '#/components/schemas/FieldAttributes'
fieldType:
$ref: '#/components/schemas/Type'
isInitOnly:
type: boolean
readOnly: true
isLiteral:
type: boolean
readOnly: true
isNotSerialized:
type: boolean
readOnly: true
isPinvokeImpl:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isStatic:
type: boolean
readOnly: true
isAssembly:
type: boolean
readOnly: true
isFamily:
type: boolean
readOnly: true
isFamilyAndAssembly:
type: boolean
readOnly: true
isFamilyOrAssembly:
type: boolean
readOnly: true
isPrivate:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
fieldHandle:
$ref: '#/components/schemas/RuntimeFieldHandle'
GenericParameterAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 3
- 4
- 8
- 16
- 28
GroupModel:
type: object
properties:
groupId:
type: integer
format: int32
groupName:
type: string
orgId:
type: integer
format: int32
IAspectFriendlyDb:
type: object
properties:
connection:
$ref: '#/components/schemas/IDbConnection'
ICustomAttributeProvider:
type: object
IDbConnection:
type: object
properties:
connectionString:
type: string
connectionTimeout:
type: integer
format: int32
readOnly: true
database:
type: string
readOnly: true
state:
$ref: '#/components/schemas/ConnectionState'
IntPtr:
type: object
ITRONAlarmModel:
type: object
properties:
lowBattery:
type: integer
format: int32
criticalError:
type: integer
format: int32
flashDataError:
type: integer
format: int32
meterQuietModeExit:
type: integer
format: int32
enteringOpenWayRivaNetworkMode:
type: integer
format: int32
batteryParamsSet:
type: integer
format: int32
deviceNotCommunicating:
type: integer
format: int32
manualTimeSync:
type: integer
format: int32
timeSyncOverThresholdDetected:
type: integer
format: int32
timeSyncOverThresholdEnded:
type: integer
format: int32
deviceReconfigured:
type: integer
format: int32
eventLogCleared:
type: integer
format: int32
configurationDownloaded:
type: integer
format: int32
systemReboot:
type: integer
format: int32
systemRestart:
type: integer
format: int32
improperInstallationDetected:
type: integer
format: int32
decryptionorAuthenticationFailure:
type: integer
format: int32
accessControlFailed:
type: integer
format: int32
rmaSignedAuthorizationReceived:
type: integer
format: int32
pcompChanged:
type: integer
format: int32
cutCablePulserDetected:
type: integer
format: int32
cutCablePulserEnded:
type: integer
format: int32
highFlowDetected:
type: integer
format: int32
highFlowEnded:
type: integer
format: int32
rightSizingStarted:
type: integer
format: int32
rightSizingCompleted:
type: integer
format: int32
rightSizingCanceled:
type: integer
format: int32
setMeterRightSizingParams:
type: integer
format: int32
loadProfileCleared:
type: integer
format: int32
legallyRelevantEventLogNearCapacity:
type: integer
format: int32
timeChangeExceededWarningLevel:
type: integer
format: int32
entering100SMode:
type: integer
format: int32
countRateChanged:
type: integer
format: int32
rolloverCountChanged:
type: integer
format: int32
initialIndex:
type: integer
format: int32
loadProfileIntervalChanged:
type: integer
format: int32
valveOk:
type: integer
format: int32
valveNoComms:
type: integer
format: int32
interDigit:
type: integer
format: int32
registerError:
type: integer
format: int32
invalidRead:
type: integer
format: int32
consumerLeakDetected:
type: integer
format: int32
consumerLeakEnded:
type: integer
format: int32
reverseFlowDetected:
type: integer
format: int32
reverseFlowEnded:
type: integer
format: int32
leakSensorOk:
type: integer
format: int32
leakSensorNoComms:
type: integer
format: int32
leakSensorDetached:
type: integer
format: int32
pulseMismatch:
type: integer
format: int32
registerRemoval:
type: integer
format: int32
temperatureOutofRange:
type: integer
format: int32
endofMeterLife:
type: integer
format: int32
zeroConsumptionDetected:
type: integer
format: int32
encoderProgramming:
type: integer
format: int32
emptyPipe:
type: integer
format: int32
burst:
type: integer
format: int32
lowPressure:
type: integer
format: int32
highPressure:
type: integer
format: int32
countSampleDebounceChanged:
type: integer
format: int32
countSampleWidthChanged:
type: integer
format: int32
countSampleRateChanged:
type: integer
format: int32
encoderDriverTypeChanged:
type: integer
format: int32
prescalerChanged:
type: integer
format: int32
replayAttackDetected:
type: integer
format: int32
tamperAttemptDetected:
type: integer
format: int32
imageTransferInitiated:
type: integer
format: int32
imageTransferCanceled:
type: integer
format: int32
imageTransferCancelFailed:
type: integer
format: int32
imageValidationInitiated:
type: integer
format: int32
imageValidationSuccessful:
type: integer
format: int32
imageValidationFailed:
type: integer
format: int32
imageActivationInitiated:
type: integer
format: int32
imageActivationSuccessful:
type: integer
format: int32
imageActivationFailed:
type: integer
format: int32
serviceDisconnectSucceeded:
type: integer
format: int32
serviceDisconnectFailed:
type: integer
format: int32
serviceConnectSucceeded:
type: integer
format: int32
serviceConnectFailed:
type: integer
format: int32
flowRestrictionSettingChanged:
type: integer
format: int32
flowRestrictionSettingFailed:
type: integer
format: int32
keyUpdateSucceeded:
type: integer
format: int32
keyRolloverSucceeded:
type: integer
format: int32
signingKeyUpdateSucceeded:
type: integer
format: int32
takeoverPackageAccepted:
type: integer
format: int32
takeoverPackageRejected:
type: integer
format: int32
ItronCreationModel:
type: object
properties:
serialNumber:
type: string
ertId:
type: string
deviceType:
type: integer
format: int32
channelId:
type: integer
format: int32
LayoutKind:
type: integer
format: int32
enum:
- 0
- 2
- 3
LeakDetectEventDTO:
type: object
properties:
location:
type: string
valveid:
type: string
eventdate:
type: string
leak:
type: boolean
LoginModel:
type: object
properties:
userName:
type: string
password:
type: string
LookupUsernameModel:
type: object
properties:
email:
type: string
role:
type: string
M2mCisRequestModel:
type: object
properties:
emailAddress:
type: string
MemberInfo:
type: object
properties:
memberType:
$ref: '#/components/schemas/MemberTypes'
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
name:
type: string
readOnly: true
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
MemberTypes:
type: integer
format: int32
enum:
- 1
- 2
- 4
- 8
- 16
- 32
- 64
- 128
- 191
MeterAlarmDetailsModel:
type: object
properties:
name:
type: string
value:
type: integer
format: int32
MeterAlert:
type: object
MeterImageModel:
type: object
properties:
userName:
type: string
files:
type: array
items:
type: string
serialNumber:
type: string
meter:
type: string
MeterLocationModel:
type: object
properties:
serialNumber:
type: string
lat:
type: number
format: double
lon:
type: number
format: double
meter:
type: string
MeterMetadataModel:
type: object
properties:
serialNumber:
type: string
oldSerialNumber:
type: string
meter:
type: string
manufacturer:
type: string
size:
type: string
resolution:
type: number
format: double
MeterReadingModel:
type: object
properties:
meter:
type: string
oldMeter:
type: string
readDate:
type: string
format: date-time
computeReading:
type: string
premiseId:
type: string
note:
type: string
meterSize:
type: string
userID:
type: string
finalReading:
type: string
installer:
type: string
serialNumber:
type: string
oldSerialNumber:
type: string
reason:
type: string
MeterReadsDetailsModel:
type: object
properties:
meterIds:
type: array
items:
type: integer
format: int32
MetersAlarmModel:
type: object
properties:
alarmDetails:
type: array
items:
$ref: '#/components/schemas/MeterAlarmDetailsModel'
MeterTypeModel:
type: object
properties:
value:
type: string
MethodAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 1024
- 2048
- 4096
- 8192
- 16384
- 32768
- 53248
MethodBase:
type: object
properties:
memberType:
$ref: '#/components/schemas/MemberTypes'
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
attributes:
$ref: '#/components/schemas/MethodAttributes'
methodImplementationFlags:
$ref: '#/components/schemas/MethodImplAttributes'
callingConvention:
$ref: '#/components/schemas/CallingConventions'
isAbstract:
type: boolean
readOnly: true
isConstructor:
type: boolean
readOnly: true
isFinal:
type: boolean
readOnly: true
isHideBySig:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isStatic:
type: boolean
readOnly: true
isVirtual:
type: boolean
readOnly: true
isAssembly:
type: boolean
readOnly: true
isFamily:
type: boolean
readOnly: true
isFamilyAndAssembly:
type: boolean
readOnly: true
isFamilyOrAssembly:
type: boolean
readOnly: true
isPrivate:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isConstructedGenericMethod:
type: boolean
readOnly: true
isGenericMethod:
type: boolean
readOnly: true
isGenericMethodDefinition:
type: boolean
readOnly: true
containsGenericParameters:
type: boolean
readOnly: true
methodHandle:
$ref: '#/components/schemas/RuntimeMethodHandle'
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
MethodImplAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 3
- 4
- 8
- 16
- 32
- 64
- 128
- 256
- 512
- 4096
- 65535
MethodInfo:
type: object
properties:
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
attributes:
$ref: '#/components/schemas/MethodAttributes'
methodImplementationFlags:
$ref: '#/components/schemas/MethodImplAttributes'
callingConvention:
$ref: '#/components/schemas/CallingConventions'
isAbstract:
type: boolean
readOnly: true
isConstructor:
type: boolean
readOnly: true
isFinal:
type: boolean
readOnly: true
isHideBySig:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isStatic:
type: boolean
readOnly: true
isVirtual:
type: boolean
readOnly: true
isAssembly:
type: boolean
readOnly: true
isFamily:
type: boolean
readOnly: true
isFamilyAndAssembly:
type: boolean
readOnly: true
isFamilyOrAssembly:
type: boolean
readOnly: true
isPrivate:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isConstructedGenericMethod:
type: boolean
readOnly: true
isGenericMethod:
type: boolean
readOnly: true
isGenericMethodDefinition:
type: boolean
readOnly: true
containsGenericParameters:
type: boolean
readOnly: true
methodHandle:
$ref: '#/components/schemas/RuntimeMethodHandle'
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
returnParameter:
$ref: '#/components/schemas/ParameterInfo'
returnType:
$ref: '#/components/schemas/Type'
returnTypeCustomAttributes:
$ref: '#/components/schemas/ICustomAttributeProvider'
Module:
type: object
properties:
assembly:
$ref: '#/components/schemas/Assembly'
fullyQualifiedName:
type: string
readOnly: true
name:
type: string
readOnly: true
mdStreamVersion:
type: integer
format: int32
readOnly: true
moduleVersionId:
type: string
format: uuid
readOnly: true
scopeName:
type: string
readOnly: true
moduleHandle:
$ref: '#/components/schemas/ModuleHandle'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
metadataToken:
type: integer
format: int32
readOnly: true
ModuleHandle:
type: object
properties:
mdStreamVersion:
type: integer
format: int32
readOnly: true
MultiAxisChartData:
type: object
properties:
date:
type: string
minFlow:
type: number
format: float
maxFlow:
type: number
format: float
avgFlow:
type: number
format: float
waterTemp:
type: number
format: float
ambientTemp:
type: number
format: float
consumption:
type: number
format: float
readdate:
type: string
format: date-time
cost:
type: number
format: double
ObjectLazy:
type: object
properties:
isValueCreated:
type: boolean
readOnly: true
value:
type: object
readOnly: true
OrgUnitConsumptionTypeModel:
type: object
properties:
id:
type: integer
format: int32
orgUnitId:
type: integer
format: int32
type:
type: string
ParameterAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 4
- 8
- 16
- 4096
- 8192
- 16384
- 32768
- 61440
ParameterInfo:
type: object
properties:
attributes:
$ref: '#/components/schemas/ParameterAttributes'
member:
$ref: '#/components/schemas/MemberInfo'
name:
type: string
readOnly: true
parameterType:
$ref: '#/components/schemas/Type'
position:
type: integer
format: int32
readOnly: true
isIn:
type: boolean
readOnly: true
isLcid:
type: boolean
readOnly: true
isOptional:
type: boolean
readOnly: true
isOut:
type: boolean
readOnly: true
isRetval:
type: boolean
readOnly: true
defaultValue:
type: object
readOnly: true
rawDefaultValue:
type: object
readOnly: true
hasDefaultValue:
type: boolean
readOnly: true
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
metadataToken:
type: integer
format: int32
readOnly: true
PropertyAttributes:
type: integer
format: int32
enum:
- 0
- 512
- 1024
- 4096
- 8192
- 16384
- 32768
- 62464
PropertyInfo:
type: object
properties:
name:
type: string
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
reflectedType:
$ref: '#/components/schemas/Type'
module:
$ref: '#/components/schemas/Module'
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
propertyType:
$ref: '#/components/schemas/Type'
attributes:
$ref: '#/components/schemas/PropertyAttributes'
isSpecialName:
type: boolean
readOnly: true
canRead:
type: boolean
readOnly: true
canWrite:
type: boolean
readOnly: true
getMethod:
$ref: '#/components/schemas/MethodInfo'
setMethod:
$ref: '#/components/schemas/MethodInfo'
RequestInfo:
type: object
RuntimeFieldHandle:
type: object
properties:
value:
$ref: '#/components/schemas/IntPtr'
RuntimeMethodHandle:
type: object
properties:
value:
$ref: '#/components/schemas/IntPtr'
RuntimeTypeHandle:
type: object
properties:
value:
$ref: '#/components/schemas/IntPtr'
SaveImageModel:
type: object
properties:
version:
type: integer
format: int32
extension:
type: string
meter:
type: string
serialNumber:
type: string
base64s:
type: array
items:
type: string
SecurityRuleSet:
type: integer
format: int32
enum:
- 0
- 1
- 2
SkippedInstallModel:
type: object
properties:
userID:
type: integer
format: int32
premise:
type: string
premiseAddress:
type: string
meter:
type: string
orgUnitID:
type: integer
format: int32
note:
type: string
StructLayoutAttribute:
type: object
properties:
typeId:
type: object
readOnly: true
value:
$ref: '#/components/schemas/LayoutKind'
SupportMessageModel:
type: object
properties:
orgUnitId:
type: integer
format: int32
accountId:
type: integer
format: int32
subject:
type: string
message:
type: string
TopTenConsumptionModel:
type: object
properties:
groupId:
type: integer
format: int32
startTime:
type: string
format: date-time
endTime:
type: string
format: date-time
TweDalMultiDbBLContext:
type: object
properties:
aspects:
type: array
readOnly: true
items:
$ref: '#/components/schemas/BizRuleAspect'
blContextName:
type: string
readOnly: true
dBs:
type: array
readOnly: true
items:
$ref: '#/components/schemas/IAspectFriendlyDb'
result:
type: object
blException:
$ref: '#/components/schemas/Exception'
generalException:
$ref: '#/components/schemas/Exception'
bizRuleFailed:
type: boolean
readOnly: true
dataManipulationExpected:
type: boolean
readOnly: true
setupOrTearDownFailed:
type: boolean
readOnly: true
currentMethodCallInfo:
$ref: '#/components/schemas/BLMethodCallInfo'
extendedResultEng:
type: string
Type:
type: object
properties:
name:
type: string
readOnly: true
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
isInterface:
type: boolean
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
namespace:
type: string
readOnly: true
assemblyQualifiedName:
type: string
readOnly: true
fullName:
type: string
readOnly: true
assembly:
$ref: '#/components/schemas/Assembly'
module:
$ref: '#/components/schemas/Module'
isNested:
type: boolean
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
declaringMethod:
$ref: '#/components/schemas/MethodBase'
reflectedType:
$ref: '#/components/schemas/Type'
underlyingSystemType:
$ref: '#/components/schemas/Type'
isTypeDefinition:
type: boolean
readOnly: true
isArray:
type: boolean
readOnly: true
isByRef:
type: boolean
readOnly: true
isPointer:
type: boolean
readOnly: true
isConstructedGenericType:
type: boolean
readOnly: true
isGenericParameter:
type: boolean
readOnly: true
isGenericTypeParameter:
type: boolean
readOnly: true
isGenericMethodParameter:
type: boolean
readOnly: true
isGenericType:
type: boolean
readOnly: true
isGenericTypeDefinition:
type: boolean
readOnly: true
isSZArray:
type: boolean
readOnly: true
isVariableBoundArray:
type: boolean
readOnly: true
isByRefLike:
type: boolean
readOnly: true
hasElementType:
type: boolean
readOnly: true
genericTypeArguments:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Type'
genericParameterPosition:
type: integer
format: int32
readOnly: true
genericParameterAttributes:
$ref: '#/components/schemas/GenericParameterAttributes'
attributes:
$ref: '#/components/schemas/TypeAttributes'
isAbstract:
type: boolean
readOnly: true
isImport:
type: boolean
readOnly: true
isSealed:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isClass:
type: boolean
readOnly: true
isNestedAssembly:
type: boolean
readOnly: true
isNestedFamANDAssem:
type: boolean
readOnly: true
isNestedFamily:
type: boolean
readOnly: true
isNestedFamORAssem:
type: boolean
readOnly: true
isNestedPrivate:
type: boolean
readOnly: true
isNestedPublic:
type: boolean
readOnly: true
isNotPublic:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isAutoLayout:
type: boolean
readOnly: true
isExplicitLayout:
type: boolean
readOnly: true
isLayoutSequential:
type: boolean
readOnly: true
isAnsiClass:
type: boolean
readOnly: true
isAutoClass:
type: boolean
readOnly: true
isUnicodeClass:
type: boolean
readOnly: true
isCOMObject:
type: boolean
readOnly: true
isContextful:
type: boolean
readOnly: true
isEnum:
type: boolean
readOnly: true
isMarshalByRef:
type: boolean
readOnly: true
isPrimitive:
type: boolean
readOnly: true
isValueType:
type: boolean
readOnly: true
isSignatureType:
type: boolean
readOnly: true
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
structLayoutAttribute:
$ref: '#/components/schemas/StructLayoutAttribute'
typeInitializer:
$ref: '#/components/schemas/ConstructorInfo'
typeHandle:
$ref: '#/components/schemas/RuntimeTypeHandle'
guid:
type: string
format: uuid
readOnly: true
baseType:
$ref: '#/components/schemas/Type'
isSerializable:
type: boolean
readOnly: true
containsGenericParameters:
type: boolean
readOnly: true
isVisible:
type: boolean
readOnly: true
TypeAttributes:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 16
- 24
- 32
- 128
- 256
- 1024
- 2048
- 4096
- 8192
- 16384
- 65536
- 131072
- 196608
- 262144
- 264192
- 1048576
- 12582912
TypeInfo:
type: object
properties:
name:
type: string
readOnly: true
customAttributes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/CustomAttributeData'
isCollectible:
type: boolean
readOnly: true
metadataToken:
type: integer
format: int32
readOnly: true
isInterface:
type: boolean
readOnly: true
memberType:
$ref: '#/components/schemas/MemberTypes'
namespace:
type: string
readOnly: true
assemblyQualifiedName:
type: string
readOnly: true
fullName:
type: string
readOnly: true
assembly:
$ref: '#/components/schemas/Assembly'
module:
$ref: '#/components/schemas/Module'
isNested:
type: boolean
readOnly: true
declaringType:
$ref: '#/components/schemas/Type'
declaringMethod:
$ref: '#/components/schemas/MethodBase'
reflectedType:
$ref: '#/components/schemas/Type'
underlyingSystemType:
$ref: '#/components/schemas/Type'
isTypeDefinition:
type: boolean
readOnly: true
isArray:
type: boolean
readOnly: true
isByRef:
type: boolean
readOnly: true
isPointer:
type: boolean
readOnly: true
isConstructedGenericType:
type: boolean
readOnly: true
isGenericParameter:
type: boolean
readOnly: true
isGenericTypeParameter:
type: boolean
readOnly: true
isGenericMethodParameter:
type: boolean
readOnly: true
isGenericType:
type: boolean
readOnly: true
isGenericTypeDefinition:
type: boolean
readOnly: true
isSZArray:
type: boolean
readOnly: true
isVariableBoundArray:
type: boolean
readOnly: true
isByRefLike:
type: boolean
readOnly: true
hasElementType:
type: boolean
readOnly: true
genericTypeArguments:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Type'
genericParameterPosition:
type: integer
format: int32
readOnly: true
genericParameterAttributes:
$ref: '#/components/schemas/GenericParameterAttributes'
attributes:
$ref: '#/components/schemas/TypeAttributes'
isAbstract:
type: boolean
readOnly: true
isImport:
type: boolean
readOnly: true
isSealed:
type: boolean
readOnly: true
isSpecialName:
type: boolean
readOnly: true
isClass:
type: boolean
readOnly: true
isNestedAssembly:
type: boolean
readOnly: true
isNestedFamANDAssem:
type: boolean
readOnly: true
isNestedFamily:
type: boolean
readOnly: true
isNestedFamORAssem:
type: boolean
readOnly: true
isNestedPrivate:
type: boolean
readOnly: true
isNestedPublic:
type: boolean
readOnly: true
isNotPublic:
type: boolean
readOnly: true
isPublic:
type: boolean
readOnly: true
isAutoLayout:
type: boolean
readOnly: true
isExplicitLayout:
type: boolean
readOnly: true
isLayoutSequential:
type: boolean
readOnly: true
isAnsiClass:
type: boolean
readOnly: true
isAutoClass:
type: boolean
readOnly: true
isUnicodeClass:
type: boolean
readOnly: true
isCOMObject:
type: boolean
readOnly: true
isContextful:
type: boolean
readOnly: true
isEnum:
type: boolean
readOnly: true
isMarshalByRef:
type: boolean
readOnly: true
isPrimitive:
type: boolean
readOnly: true
isValueType:
type: boolean
readOnly: true
isSignatureType:
type: boolean
readOnly: true
isSecurityCritical:
type: boolean
readOnly: true
isSecuritySafeCritical:
type: boolean
readOnly: true
isSecurityTransparent:
type: boolean
readOnly: true
structLayoutAttribute:
$ref: '#/components/schemas/StructLayoutAttribute'
typeInitializer:
$ref: '#/components/schemas/ConstructorInfo'
typeHandle:
$ref: '#/components/schemas/RuntimeTypeHandle'
guid:
type: string
format: uuid
readOnly: true
baseType:
$ref: '#/components/schemas/Type'
isSerializable:
type: boolean
readOnly: true
containsGenericParameters:
type: boolean
readOnly: true
isVisible:
type: boolean
readOnly: true
genericTypeParameters:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Type'
declaredConstructors:
type: array
readOnly: true
items:
$ref: '#/components/schemas/ConstructorInfo'
declaredEvents:
type: array
readOnly: true
items:
$ref: '#/components/schemas/EventInfo'
declaredFields:
type: array
readOnly: true
items:
$ref: '#/components/schemas/FieldInfo'
declaredMembers:
type: array
readOnly: true
items:
$ref: '#/components/schemas/MemberInfo'
declaredMethods:
type: array
readOnly: true
items:
$ref: '#/components/schemas/MethodInfo'
declaredNestedTypes:
type: array
readOnly: true
items:
$ref: '#/components/schemas/TypeInfo'
declaredProperties:
type: array
readOnly: true
items:
$ref: '#/components/schemas/PropertyInfo'
implementedInterfaces:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Type'
UserDeviceWatchlist:
type: object
properties:
devices:
type: array
items:
$ref: '#/components/schemas/DeviceWatchlistModel'
UserLoginModel:
type: object
properties:
userName:
type: string
password:
type: string
ValveEventDTO:
type: object
ValveImageDTO:
type: object
ValveNoteDTO:
type: object
WaterConsumptionDetailsModel:
type: object
properties:
display:
type: string
format: date-time
count:
type: number
format: double
cost:
type: number
format: double
waterTemp:
type: number
format: float
ambientTemp:
type: number
format: float
WaterConsumptionModel:
type: object
properties:
time:
type: integer
format: int32
consumptionDetail:
type: array
items:
$ref: '#/components/schemas/WaterConsumptionDetailsModel'
consumptionDetailToPrevious:
type: array
items:
$ref: '#/components/schemas/WaterConsumptionDetailsModel'
WhatsNewModel:
type: object
properties:
id:
type: integer
format: int32
isActive:
type: boolean
dateCreated:
type: string
format: date-time
userIDCreatedBy:
type: integer
format: int32
title:
type: string
htmlContent:
type: string
originalContent:
type: string
WidgetOrderModel:
type: object
properties:
isItronOrg:
type: boolean
id:
type: integer
format: int32
userID:
type: integer
format: int32
billing:
type: boolean
billingIndex:
type: integer
format: int32
billingID:
type: integer
format: int32
billingRow:
type: integer
format: int32
billingColumn:
type: integer
format: int32
seTflowAlarms:
type: boolean
seTflowAlarmsIndex:
type: integer
format: int32
seTflowAlarmsID:
type: integer
format: int32
seTflowAlarmsRow:
type: integer
format: int32
seTflowAlarmsColumn:
type: integer
format: int32
waterUsage:
type: boolean
waterUsageIndex:
type: integer
format: int32
waterUsageID:
type: integer
format: int32
waterUsageRow:
type: integer
format: int32
waterUsageColumn:
type: integer
format: int32
techSupport:
type: boolean
techSupportIndex:
type: integer
format: int32
techSupportID:
type: integer
format: int32
techSupportRow:
type: integer
format: int32
techSupportColumn:
type: integer
format: int32
whatsNew:
type: boolean
whatsNewIndex:
type: integer
format: int32
whatsNewID:
type: integer
format: int32
whatsNewRow:
type: integer
format: int32
whatsNewColumn:
type: integer
format: int32
valveAlarm:
type: boolean
valveAlarmIndex:
type: integer
format: int32
valveAlarmID:
type: integer
format: int32
valveAlarmRow:
type: integer
format: int32
valveAlarmColumn:
type: integer
format: int32
deviceWatchlist:
type: boolean
deviceWatchlistIndex:
type: integer
format: int32
deviceWatchlistID:
type: integer
format: int32
deviceWatchlistRow:
type: integer
format: int32
deviceWatchlistColumn:
type: integer
format: int32
topTen:
type: boolean
topTenIndex:
type: integer
format: int32
topTenID:
type: integer
format: int32
topTenRow:
type: integer
format: int32
topTenColumn:
type: integer
format: int32
itronAlarm:
type: boolean
itronAlarmIndex:
type: integer
format: int32
itronAlarmID:
type: integer
format: int32
itronAlarmRow:
type: integer
format: int32
itronAlarmColumn:
type: integer
format: int32
comms:
type: boolean
commsIndex:
type: integer
format: int32
commsID:
type: integer
format: int32
commsRow:
type: integer
format: int32
commsColumn:
type: integer
format: int32
rows:
type: integer
format: int32
forOrgUnit:
type: boolean
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment