get

/v1/config/updates/site/meters/light

https://platform.sitepro.com/v1/config/updates/site/meters/light

Get meter configuration updates for a site (light payload)

Expected responses

{
  "description": "",
  "content": {
    "application/json": {
      "schema": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "meter": {
              "type": "object",
              "properties": {
                "SiteFlowMeterID": {
                  "type": "number",
                  "example": 220
                },
                "SiteID": {
                  "type": "number",
                  "example": 789
                },
                "Name": {
                  "type": "string",
                  "example": "Intake Meter"
                },
                "VolumeUnits": {
                  "type": "string",
                  "example": "bbl",
                  "nullable": true
                },
                "FlowUnits": {
                  "type": "string",
                  "example": "bbl/d",
                  "nullable": true
                },
                "VolumeUnitID": {
                  "type": "number",
                  "example": 4,
                  "nullable": true
                },
                "MeterTypeID": {
                  "type": "number",
                  "example": 1,
                  "nullable": true
                },
                "SiteSensorID": {
                  "type": "number",
                  "example": 4321,
                  "nullable": true
                },
                "SiteFluidTypeID": {
                  "type": "number",
                  "example": 2,
                  "nullable": true
                },
                "LoggingEnabled": {
                  "type": "boolean",
                  "example": true,
                  "nullable": true
                },
                "Latitude": {
                  "type": "number",
                  "example": 33.508,
                  "nullable": true
                },
                "Longitude": {
                  "type": "number",
                  "example": -101.855,
                  "nullable": true
                }
              },
              "required": [
                "SiteFlowMeterID",
                "SiteID",
                "Name"
              ]
            },
            "meterRegisters": {
              "type": "object",
              "additionalProperties": {
                "allOf": [
                  {
                    "type": "object",
                    "properties": {
                      "SiteIODeviceRegisterID": {
                        "type": "string",
                        "description": "SiteIODeviceRegisterID (bigint serialized as string)",
                        "example": "10231"
                      },
                      "SiteModbusInOutDeviceID": {
                        "type": "number",
                        "description": "Owning Modbus device id",
                        "example": 55
                      },
                      "Register": {
                        "type": "number",
                        "description": "Modbus register address",
                        "example": 40001
                      },
                      "RegisterDataType": {
                        "type": "number",
                        "description": "Register data type code",
                        "example": 3
                      },
                      "RegisterSize": {
                        "type": "number",
                        "description": "Register size (words)",
                        "example": 2
                      },
                      "RegisterClassification": {
                        "type": "number",
                        "description": "Register classification code",
                        "example": 1
                      },
                      "RegisterAccessType": {
                        "type": "number",
                        "description": "Register access type code",
                        "example": 0,
                        "nullable": true
                      },
                      "BitIndex": {
                        "type": "number",
                        "description": "Bit index within the register",
                        "example": 0,
                        "nullable": true
                      },
                      "ScalingMultiplierValue": {
                        "type": "number",
                        "description": "Scaling multiplier",
                        "example": 1,
                        "nullable": true
                      },
                      "ScalingDividerValue": {
                        "type": "number",
                        "description": "Scaling divider",
                        "example": 1,
                        "nullable": true
                      },
                      "ScalingEquation": {
                        "type": "string",
                        "description": "Read scaling equation",
                        "nullable": true
                      },
                      "WriteScalingEquation": {
                        "type": "string",
                        "description": "Write scaling equation",
                        "nullable": true
                      },
                      "Units": {
                        "type": "string",
                        "description": "Units label",
                        "example": "psi",
                        "nullable": true
                      },
                      "UnitID": {
                        "type": "number",
                        "description": "Unit id",
                        "example": 7,
                        "nullable": true
                      },
                      "Name": {
                        "type": "string",
                        "description": "Register name",
                        "nullable": true
                      },
                      "Description": {
                        "type": "string",
                        "description": "Register description",
                        "nullable": true
                      },
                      "Deleted": {
                        "type": "boolean",
                        "description": "Soft-delete flag",
                        "example": false,
                        "nullable": true
                      },
                      "SiteModbusInOutDevices": {
                        "description": "Owning Modbus device (name + slave address)",
                        "allOf": [
                          {
                            "type": "object",
                            "properties": {
                              "DeviceName": {
                                "type": "string",
                                "description": "Modbus device name",
                                "example": "PLC-1"
                              },
                              "SlaveAddress": {
                                "type": "number",
                                "description": "Modbus slave address",
                                "example": 1
                              }
                            },
                            "required": [
                              "DeviceName",
                              "SlaveAddress"
                            ]
                          }
                        ]
                      },
                      "ConnectionName": {
                        "type": "string",
                        "description": "Connection name (sensor-attached registers)",
                        "nullable": true
                      },
                      "ConnectionSlaveAddress": {
                        "type": "number",
                        "description": "Connection slave address",
                        "nullable": true
                      },
                      "ConnectionSensorID": {
                        "type": "number",
                        "description": "Connection sensor id",
                        "nullable": true
                      }
                    },
                    "required": [
                      "SiteIODeviceRegisterID",
                      "SiteModbusInOutDeviceID",
                      "Register",
                      "RegisterDataType",
                      "RegisterSize",
                      "RegisterClassification"
                    ]
                  }
                ],
                "nullable": true
              }
            },
            "sensorRegisters": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "SiteIODeviceRegisterID": {
                    "type": "string",
                    "description": "SiteIODeviceRegisterID (bigint serialized as string)",
                    "example": "10231"
                  },
                  "SiteModbusInOutDeviceID": {
                    "type": "number",
                    "description": "Owning Modbus device id",
                    "example": 55
                  },
                  "Register": {
                    "type": "number",
                    "description": "Modbus register address",
                    "example": 40001
                  },
                  "RegisterDataType": {
                    "type": "number",
                    "description": "Register data type code",
                    "example": 3
                  },
                  "RegisterSize": {
                    "type": "number",
                    "description": "Register size (words)",
                    "example": 2
                  },
                  "RegisterClassification": {
                    "type": "number",
                    "description": "Register classification code",
                    "example": 1
                  },
                  "RegisterAccessType": {
                    "type": "number",
                    "description": "Register access type code",
                    "example": 0,
                    "nullable": true
                  },
                  "BitIndex": {
                    "type": "number",
                    "description": "Bit index within the register",
                    "example": 0,
                    "nullable": true
                  },
                  "ScalingMultiplierValue": {
                    "type": "number",
                    "description": "Scaling multiplier",
                    "example": 1,
                    "nullable": true
                  },
                  "ScalingDividerValue": {
                    "type": "number",
                    "description": "Scaling divider",
                    "example": 1,
                    "nullable": true
                  },
                  "ScalingEquation": {
                    "type": "string",
                    "description": "Read scaling equation",
                    "nullable": true
                  },
                  "WriteScalingEquation": {
                    "type": "string",
                    "description": "Write scaling equation",
                    "nullable": true
                  },
                  "Units": {
                    "type": "string",
                    "description": "Units label",
                    "example": "psi",
                    "nullable": true
                  },
                  "UnitID": {
                    "type": "number",
                    "description": "Unit id",
                    "example": 7,
                    "nullable": true
                  },
                  "Name": {
                    "type": "string",
                    "description": "Register name",
                    "nullable": true
                  },
                  "Description": {
                    "type": "string",
                    "description": "Register description",
                    "nullable": true
                  },
                  "Deleted": {
                    "type": "boolean",
                    "description": "Soft-delete flag",
                    "example": false,
                    "nullable": true
                  },
                  "SiteModbusInOutDevices": {
                    "description": "Owning Modbus device (name + slave address)",
                    "allOf": [
                      {
                        "type": "object",
                        "properties": {
                          "DeviceName": {
                            "type": "string",
                            "description": "Modbus device name",
                            "example": "PLC-1"
                          },
                          "SlaveAddress": {
                            "type": "number",
                            "description": "Modbus slave address",
                            "example": 1
                          }
                        },
                        "required": [
                          "DeviceName",
                          "SlaveAddress"
                        ]
                      }
                    ]
                  },
                  "ConnectionName": {
                    "type": "string",
                    "description": "Connection name (sensor-attached registers)",
                    "nullable": true
                  },
                  "ConnectionSlaveAddress": {
                    "type": "number",
                    "description": "Connection slave address",
                    "nullable": true
                  },
                  "ConnectionSensorID": {
                    "type": "number",
                    "description": "Connection sensor id",
                    "nullable": true
                  }
                },
                "required": [
                  "SiteIODeviceRegisterID",
                  "SiteModbusInOutDeviceID",
                  "Register",
                  "RegisterDataType",
                  "RegisterSize",
                  "RegisterClassification"
                ]
              }
            }
          },
          "required": [
            "meter",
            "meterRegisters",
            "sensorRegisters"
          ]
        }
      }
    }
  }
}

Related schemas

curl -X GET 
  -H "Authorization: Bearer <JWT_Token>" 
  "https://platform.sitepro.com/v1/config/updates/site/meters/light"

Authorization

Bearer

Properties