get

/v1/config/site/compact

https://platform.sitepro.com/v1/config/site/compact

Get compact configuration for a site

Expected responses

{
  "description": "",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "devices": {
            "type": "object",
            "description": "Devices keyed by SiteModbusInOutDeviceID",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "SiteModbusInOutDeviceID": {
                  "type": "number",
                  "example": 55
                },
                "SiteID": {
                  "type": "number",
                  "example": 789
                },
                "DeviceName": {
                  "type": "string",
                  "example": "PLC-1"
                },
                "SlaveAddress": {
                  "type": "number",
                  "example": 1
                },
                "IPAddress": {
                  "type": "string",
                  "example": "192.168.1.50",
                  "nullable": true
                },
                "Active": {
                  "type": "boolean",
                  "example": true,
                  "nullable": true
                },
                "SupportedIOProtocolID": {
                  "type": "number",
                  "example": 2,
                  "nullable": true
                },
                "LastCommunication": {
                  "type": "string",
                  "format": "date-time",
                  "nullable": true
                }
              },
              "required": [
                "SiteModbusInOutDeviceID",
                "SiteID",
                "DeviceName",
                "SlaveAddress"
              ]
            }
          },
          "registers": {
            "type": "object",
            "description": "Deduped registers keyed by SiteIODeviceRegisterID (null/undefined props stripped)",
            "additionalProperties": {
              "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"
              ]
            }
          },
          "sensors": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "sensor": {
                  "type": "object",
                  "properties": {
                    "SiteSensorID": {
                      "type": "number",
                      "example": 4321
                    },
                    "SiteID": {
                      "type": "number",
                      "example": 789
                    },
                    "Name": {
                      "type": "string",
                      "example": "Tank 1 Level"
                    },
                    "Units": {
                      "type": "string",
                      "example": "ft"
                    },
                    "Active": {
                      "type": "boolean",
                      "example": true
                    },
                    "ConvertedUnits": {
                      "type": "string",
                      "example": "ft",
                      "nullable": true
                    },
                    "SiteSensorTypeID": {
                      "type": "number",
                      "example": 3,
                      "nullable": true
                    },
                    "SiteSensorSubTypeID": {
                      "type": "number",
                      "example": 1,
                      "nullable": true
                    },
                    "AlarmEnabled": {
                      "type": "boolean",
                      "example": true,
                      "nullable": true
                    },
                    "LoggingEnabled": {
                      "type": "boolean",
                      "example": true,
                      "nullable": true
                    },
                    "UnitID": {
                      "type": "number",
                      "example": 7,
                      "nullable": true
                    },
                    "ConvertedUnitID": {
                      "type": "number",
                      "example": 7,
                      "nullable": true
                    },
                    "EquipmentID": {
                      "type": "string",
                      "description": "EquipmentID (bigint serialized as string)",
                      "example": "99001",
                      "nullable": true
                    },
                    "EquipmentTypeID": {
                      "type": "number",
                      "example": 10,
                      "nullable": true
                    },
                    "Latitude": {
                      "type": "number",
                      "description": "Latitude (Decimal serialized as number)",
                      "example": 33.508,
                      "nullable": true
                    },
                    "Longitude": {
                      "type": "number",
                      "description": "Longitude (Decimal serialized as number)",
                      "example": -101.855,
                      "nullable": true
                    }
                  },
                  "required": [
                    "SiteSensorID",
                    "SiteID",
                    "Name",
                    "Units",
                    "Active"
                  ]
                },
                "registerIds": {
                  "description": "Register ids (bigint serialized as string)",
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "sensor",
                "registerIds"
              ]
            }
          },
          "meters": {
            "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",
                  "description": "Register role name → register id (or null)",
                  "additionalProperties": {
                    "type": "number",
                    "nullable": true
                  }
                },
                "sensorRegisterIds": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "meter",
                "meterRegisters",
                "sensorRegisterIds"
              ]
            }
          },
          "pumps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "pump": {
                  "type": "object",
                  "properties": {
                    "SitePumpID": {
                      "type": "number",
                      "example": 610
                    },
                    "SiteID": {
                      "type": "number",
                      "example": 789
                    },
                    "Name": {
                      "type": "string",
                      "example": "Transfer Pump"
                    },
                    "IsVFD": {
                      "type": "boolean",
                      "example": true
                    },
                    "Active": {
                      "type": "boolean",
                      "example": true
                    },
                    "SitePumpTypeID": {
                      "type": "number",
                      "example": 2,
                      "nullable": true
                    },
                    "MaximumFrequency": {
                      "type": "number",
                      "example": 60
                    },
                    "MinimumFrequency": {
                      "type": "number",
                      "example": 0
                    },
                    "MaximumFlow": {
                      "type": "number",
                      "example": 500
                    },
                    "MinimumFlow": {
                      "type": "number",
                      "example": 0
                    },
                    "LoggingEnabled": {
                      "type": "boolean",
                      "example": true,
                      "nullable": true
                    },
                    "DesignTypeID": {
                      "type": "number",
                      "example": 1,
                      "nullable": true
                    },
                    "Latitude": {
                      "type": "number",
                      "example": 33.508,
                      "nullable": true
                    },
                    "Longitude": {
                      "type": "number",
                      "example": -101.855,
                      "nullable": true
                    }
                  },
                  "required": [
                    "SitePumpID",
                    "SiteID",
                    "Name",
                    "IsVFD",
                    "Active",
                    "MaximumFrequency",
                    "MinimumFrequency",
                    "MaximumFlow",
                    "MinimumFlow"
                  ]
                },
                "pumpRegisters": {
                  "type": "object",
                  "description": "Register role name → register id (or null)",
                  "additionalProperties": {
                    "type": "number",
                    "nullable": true
                  }
                },
                "sensorRegisterIds": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "pump",
                "pumpRegisters",
                "sensorRegisterIds"
              ]
            }
          },
          "tankGroups": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "tankGroup": {
                  "type": "object",
                  "properties": {
                    "SiteTankGroupID": {
                      "type": "number",
                      "example": 300
                    },
                    "SiteID": {
                      "type": "number",
                      "example": 789
                    },
                    "Name": {
                      "type": "string",
                      "example": "Battery A"
                    },
                    "Capacity": {
                      "type": "number",
                      "example": 500
                    },
                    "MaximumHeightLevel": {
                      "type": "number",
                      "example": 20
                    },
                    "MinimumHeightLevel": {
                      "type": "number",
                      "example": 0
                    },
                    "NumberOfTanks": {
                      "type": "number",
                      "example": 4
                    },
                    "IsOil": {
                      "type": "boolean",
                      "example": true
                    },
                    "SiteTankGroupTypeID": {
                      "type": "number",
                      "example": 1
                    },
                    "Active": {
                      "type": "boolean",
                      "example": true
                    },
                    "VolumeUnitID": {
                      "type": "number",
                      "example": 4,
                      "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": [
                    "SiteTankGroupID",
                    "SiteID",
                    "Name",
                    "Capacity",
                    "MaximumHeightLevel",
                    "MinimumHeightLevel",
                    "NumberOfTanks",
                    "IsOil",
                    "SiteTankGroupTypeID",
                    "Active"
                  ]
                },
                "tankRegisters": {
                  "type": "object",
                  "description": "Register role name → register id (or null)",
                  "additionalProperties": {
                    "type": "number",
                    "nullable": true
                  }
                },
                "sensorRegisterIds": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "tankGroup",
                "tankRegisters",
                "sensorRegisterIds"
              ]
            }
          },
          "actuators": {
            "description": "All actuators for the site, including on /updates (actuator tables have no update timestamp)",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "actuator": {
                  "type": "object",
                  "properties": {
                    "SiteActuatorID": {
                      "type": "number",
                      "example": 1
                    },
                    "SiteID": {
                      "type": "number",
                      "example": 789
                    },
                    "SiteActuatorStatusID": {
                      "type": "number",
                      "example": 3
                    },
                    "Name": {
                      "type": "string",
                      "example": "Tank Actuator"
                    },
                    "SiteInOutDeviceID": {
                      "type": "number",
                      "example": null,
                      "nullable": true
                    },
                    "SiteModbusInOutDeviceID": {
                      "type": "number",
                      "example": 63,
                      "nullable": true
                    },
                    "FullyClosedChannel": {
                      "type": "number",
                      "example": 2
                    },
                    "FullyOpenChannel": {
                      "type": "number",
                      "example": 1
                    },
                    "CloseChannel": {
                      "type": "number",
                      "example": 2
                    },
                    "OpenChannel": {
                      "type": "number",
                      "example": 1
                    },
                    "DigitalInMissingAlarmActive": {
                      "type": "boolean",
                      "example": false
                    },
                    "DigitalInMissingAlarmDescription": {
                      "type": "string",
                      "example": ""
                    },
                    "Auto": {
                      "type": "boolean",
                      "example": false
                    },
                    "LoggingEnabled": {
                      "type": "boolean",
                      "description": "Omitted from light responses",
                      "example": true
                    },
                    "UsesAnalogControl": {
                      "type": "boolean",
                      "example": false,
                      "nullable": true
                    },
                    "AnalogOutChannel": {
                      "type": "number",
                      "example": 3,
                      "nullable": true
                    },
                    "AnalogOutSiteModbusInOutDeviceID": {
                      "type": "number",
                      "example": 63,
                      "nullable": true
                    },
                    "AnalogInValvePositionChannel": {
                      "type": "number",
                      "example": 4,
                      "nullable": true
                    },
                    "AnalogInSiteModbusInOutDeviceID": {
                      "type": "number",
                      "example": 63,
                      "nullable": true
                    },
                    "FullyOpenPosition": {
                      "type": "number",
                      "example": 100,
                      "nullable": true
                    },
                    "FullyClosedPosition": {
                      "type": "number",
                      "example": 0,
                      "nullable": true
                    },
                    "DigitalOpenValveRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10231",
                      "nullable": true
                    },
                    "DigitalCloseValveRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10232",
                      "nullable": true
                    },
                    "DigitalFullyOpenValveRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10233",
                      "nullable": true
                    },
                    "DigitalFullyClosedValveRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10234",
                      "nullable": true
                    },
                    "AnalogOpenValveRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10235",
                      "nullable": true
                    },
                    "AnalogValvePositionRegisterID": {
                      "type": "string",
                      "description": "bigint serialized as string",
                      "example": "10236",
                      "nullable": true
                    },
                    "AnalogValvePositionSensorID": {
                      "type": "number",
                      "example": 4321,
                      "nullable": true
                    },
                    "CurrentValvePosition": {
                      "type": "number",
                      "description": "Omitted from light responses",
                      "example": 75,
                      "nullable": true
                    },
                    "LastClosed": {
                      "type": "string",
                      "description": "Omitted from light responses",
                      "format": "date-time",
                      "nullable": true
                    },
                    "LastOpened": {
                      "type": "string",
                      "description": "Omitted from light responses",
                      "format": "date-time",
                      "nullable": true
                    },
                    "ESDState": {
                      "type": "number",
                      "example": 0,
                      "nullable": true
                    },
                    "ESDCustomPosition": {
                      "type": "number",
                      "example": 0,
                      "nullable": true
                    },
                    "MonitorStatusIndicators": {
                      "type": "boolean",
                      "example": true,
                      "nullable": true
                    },
                    "MaxTimeToFullyOpen": {
                      "type": "number",
                      "example": 30,
                      "nullable": true
                    },
                    "MaxTimeToFullyClose": {
                      "type": "number",
                      "example": 30,
                      "nullable": true
                    },
                    "DefaultAction": {
                      "type": "number",
                      "example": 1,
                      "nullable": true
                    },
                    "DefaultPosition": {
                      "type": "number",
                      "example": 0,
                      "nullable": true
                    },
                    "Delete": {
                      "type": "boolean",
                      "example": false,
                      "nullable": true
                    },
                    "DesignTypeID": {
                      "type": "number",
                      "description": "Omitted from light responses",
                      "example": 1,
                      "nullable": true
                    },
                    "Latitude": {
                      "type": "number",
                      "description": "Omitted from light responses",
                      "example": 33.508,
                      "nullable": true
                    },
                    "Longitude": {
                      "type": "number",
                      "description": "Omitted from light responses",
                      "example": -101.855,
                      "nullable": true
                    },
                    "CustomIconURL": {
                      "type": "string",
                      "description": "Omitted from light responses",
                      "example": null,
                      "nullable": true
                    }
                  },
                  "required": [
                    "SiteActuatorID",
                    "SiteID",
                    "SiteActuatorStatusID",
                    "Name",
                    "FullyClosedChannel",
                    "FullyOpenChannel",
                    "CloseChannel",
                    "OpenChannel",
                    "DigitalInMissingAlarmActive",
                    "DigitalInMissingAlarmDescription",
                    "Auto"
                  ]
                },
                "sensorScalings": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "SiteActuatorSensorScalingID": {
                        "type": "number",
                        "example": 4
                      },
                      "SiteActuatorID": {
                        "type": "number",
                        "example": 1
                      },
                      "SiteSensorID": {
                        "type": "number",
                        "example": 3658
                      },
                      "Active": {
                        "type": "boolean",
                        "example": false
                      },
                      "ScalePoints": {
                        "description": "Parsed from the stored JSON; empty when unset or unparseable",
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "F": {
                              "type": "number",
                              "description": "Actuator position (percent)",
                              "example": 75
                            },
                            "V": {
                              "type": "number",
                              "description": "Sensor value",
                              "example": 10
                            }
                          },
                          "required": [
                            "F",
                            "V"
                          ]
                        }
                      }
                    },
                    "required": [
                      "SiteActuatorSensorScalingID",
                      "SiteActuatorID",
                      "SiteSensorID",
                      "Active",
                      "ScalePoints"
                    ]
                  }
                },
                "sensorTriggers": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "SiteActuatorID": {
                        "type": "number",
                        "example": 1
                      },
                      "SiteSensorID": {
                        "type": "number",
                        "example": 25011
                      },
                      "TopAlarmActuatorAction": {
                        "type": "number",
                        "example": 2
                      },
                      "TopAlarmCustomPosition": {
                        "type": "number",
                        "example": 0
                      },
                      "BottomAlarmActuatorAction": {
                        "type": "number",
                        "example": 2
                      },
                      "BottomAlarmCustomPosition": {
                        "type": "number",
                        "example": 0
                      },
                      "TimeBased": {
                        "type": "boolean",
                        "example": false
                      },
                      "TopAlarmActionActiveTime": {
                        "type": "number",
                        "example": 0,
                        "nullable": true
                      },
                      "TopAlarmActionInactiveTime": {
                        "type": "number",
                        "example": 0,
                        "nullable": true
                      },
                      "BottomAlarmActionActiveTime": {
                        "type": "number",
                        "example": 0,
                        "nullable": true
                      },
                      "BottomAlarmActionInactiveTime": {
                        "type": "number",
                        "example": 0,
                        "nullable": true
                      },
                      "Active": {
                        "type": "boolean",
                        "example": false
                      }
                    },
                    "required": [
                      "SiteActuatorID",
                      "SiteSensorID",
                      "TopAlarmActuatorAction",
                      "TopAlarmCustomPosition",
                      "BottomAlarmActuatorAction",
                      "BottomAlarmCustomPosition",
                      "TimeBased",
                      "Active"
                    ]
                  }
                },
                "tankGroupConnections": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "SiteActuatorTankGroupConnectionID": {
                        "type": "number",
                        "example": 4
                      },
                      "SiteActuatorID": {
                        "type": "number",
                        "example": 1
                      },
                      "SiteTankGroupID": {
                        "type": "number",
                        "example": 836
                      },
                      "SiteMiddleTankID": {
                        "type": "number",
                        "example": 12,
                        "nullable": true
                      },
                      "LevelToOpen": {
                        "type": "number",
                        "example": 21
                      },
                      "LevelToClose": {
                        "type": "number",
                        "example": 22
                      },
                      "LevelToAlertClose": {
                        "type": "number",
                        "example": 21.5
                      },
                      "Active": {
                        "type": "boolean",
                        "example": false
                      }
                    },
                    "required": [
                      "SiteActuatorTankGroupConnectionID",
                      "SiteActuatorID",
                      "SiteTankGroupID",
                      "LevelToOpen",
                      "LevelToClose",
                      "LevelToAlertClose",
                      "Active"
                    ]
                  }
                }
              },
              "required": [
                "actuator",
                "sensorScalings",
                "sensorTriggers",
                "tankGroupConnections"
              ]
            }
          }
        },
        "required": [
          "devices",
          "registers",
          "sensors",
          "meters",
          "pumps",
          "tankGroups",
          "actuators"
        ]
      }
    }
  }
}

Related schemas

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

Authorization

Bearer

Properties