{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/eagle-eye-networks/json-schema/eagle-eye-networks-api-paginated-multi-camera-response-schema.json",
  "title": "ApiPaginatedMultiCameraResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/eagle-eye-networks-multi-cameras-api-openapi.yml#/components/schemas/ApiPaginatedMultiCameraResponse",
  "allOf": [
    {
      "$ref": "#/$defs/PaginatedResponseWithSize"
    },
    {
      "type": "object",
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApiMultiCameraWithIncludes"
          }
        }
      }
    }
  ],
  "$defs": {
    "ApiAdapterInfo": {
      "type": "object",
      "properties": {
        "macAddress": {
          "$ref": "#/$defs/MacAddress"
        },
        "ipAddress": {
          "$ref": "#/$defs/IpAddress"
        }
      }
    },
    "ApiDeviceInfo3": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "icon": {
          "description": "Icon of multi camera.",
          "type": "string"
        },
        "make": {
          "description": "The Manufactorer or brand of the multi camera.",
          "type": "string"
        },
        "model": {
          "description": "The model of the multi camera.",
          "type": "string"
        },
        "guid": {
          "$ref": "#/$defs/Guid3"
        }
      }
    },
    "ApiDevicePosition": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "latitude": {
          "description": "The latitude of the device. (WGS 84)",
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "minimum": -90,
          "maximum": 90
        },
        "longitude": {
          "description": "The longitude of the device. (WGS 84).",
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "minimum": -180,
          "maximum": 180
        },
        "azimuth": {
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "minimum": 0,
          "maximum": 360
        },
        "rangeInMeters": {
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "minimum": 0
        },
        "floor": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": -30,
          "maximum": 300
        },
        "fieldOfView": {
          "description": "Field of view is the range of the observable world visible at any given time through camera viewfinder.",
          "type": [
            "number",
            "null"
          ],
          "format": "double",
          "minimum": 0,
          "maximum": 360
        }
      }
    },
    "ApiFirmware": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "currentVersion": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "ApiMultiCameraIncludes": {
      "type": "object",
      "properties": {
        "status": {
          "$ref": "#/$defs/DeviceStatus"
        },
        "statusV2": {
          "$ref": "#/$defs/DeviceStatusV2"
        },
        "locationSummary": {
          "$ref": "#/$defs/LocationSummary"
        },
        "deviceAddress": {
          "$ref": "#/$defs/DeviceAddress"
        },
        "timeZone": {
          "$ref": "#/$defs/ApiTimeZone"
        },
        "notes": {
          "$ref": "#/$defs/DeviceNotes"
        },
        "tags": {
          "$ref": "#/$defs/DeviceTags"
        },
        "devicePosition": {
          "$ref": "#/$defs/ApiDevicePosition"
        },
        "networkInfo": {
          "$ref": "#/$defs/ApiNetworkInfoWithMainIp"
        },
        "deviceInfo": {
          "$ref": "#/$defs/ApiDeviceInfo3"
        },
        "firmware": {
          "$ref": "#/$defs/ApiFirmware"
        },
        "visibleByBridges": {
          "type": "array",
          "x-jsoninclude-nonnull-annotation": true,
          "items": {
            "type": "string",
            "pattern": "^(?:0[xX])?[0-9a-fA-F]{8}$"
          }
        },
        "effectivePermissions": {
          "$ref": "#/$defs/EffectiveMulticameraPermissions"
        }
      }
    },
    "ApiMultiCameraMain": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "accountId": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "bridgeId": {
          "$ref": "#/$defs/BridgeId3"
        },
        "locationId": {
          "$ref": "#/$defs/LocationId"
        }
      },
      "required": [
        "id",
        "accountId",
        "name",
        "bridgeId"
      ]
    },
    "ApiMultiCameraWithIncludes": {
      "allOf": [
        {
          "$ref": "#/$defs/ApiMultiCameraMain"
        },
        {
          "$ref": "#/$defs/ApiMultiCameraIncludes"
        },
        {
          "type": "object"
        }
      ]
    },
    "ApiNetworkInfoWithMainIp": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "globalIP": {
          "$ref": "#/$defs/IpAddress"
        },
        "ipUsedByBridge": {
          "$ref": "#/$defs/IpUsedByBridge"
        },
        "adapters": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApiAdapterInfo"
          }
        }
      }
    },
    "ApiTimeZone": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "zone": {
          "type": "string",
          "description": "The timezone the device is in. The list of supported timezones is provided by the [/timeZones](https://developer.eagleeyenetworks.com/reference/listtimezones) endpoint."
        }
      }
    },
    "BridgeId3": {
      "type": "string",
      "pattern": "^(?:0[xX])?[0-9a-fA-F]{8}$",
      "description": "The bridge a multi camera is connected to. \n"
    },
    "DeviceAddress": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "description": "Address of the device.",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "address": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "DeviceCommonStatus": {
      "description": "Indicates the operational status of the device. The statuses defined here should be in sync with the DeviceStatus schema.\n  * `operational`: The device is online and operational.\n  * `error`: Device not working (requires error details).\n  * `disabled`: Operational but intentionally not recording telemetry\n  * `unreachable`: The device is not reachable (e.g., offline, out of service).\n  * `unknown`: The device state is unknown for some reason.\n  * `initializing`: The device is in the process of initializing.\n",
      "type": "string",
      "enum": [
        "operational",
        "error",
        "disabled",
        "unreachable",
        "unknown",
        "initializing"
      ]
    },
    "DeviceConnectionStatus": {
      "type": "string",
      "description": "Indicates the connection status of the device:\n  * `online`: The device is online and operational.\n  * `deviceOffline`: The device is offline.\n  * `invalidCredentials`: The known credentials for this device, including the default credentials, are invalid. This is causing the device to appear offline.\n  * `bridgeOffline`: The bridge that connects this device to the cloud is offline. However, both the device and the bridge may still be operational locally, even though the cloud has no visibility into their status.\n  * `off`: The device is online, but has been turned off by the user.\n  * `error`: The device is offline due to some problem that has not been described by any of the other statuses.\n  * `busy`: The device is currently busy and unavailable for other operations.\n  * `unknown`: The device state is unknown for some reason.\n",
      "enum": [
        "online",
        "deviceOffline",
        "invalidCredentials",
        "bridgeOffline",
        "off",
        "error",
        "busy",
        "unknown"
      ]
    },
    "DeviceErrorStatus": {
      "description": "Indicates the detailed error status of a device, grouped by device type:\nONVIF Camera / RTSP Camera / Multicamera:\n  * `generalDeviceError`: Camera error\n  * `networkError`: Network error\n  * `invalidCredentials`: Invalid credentials\n  * `deviceSupportIssue`: Device support issue\n  * `queuedForConfiguration`: Queued for configuration\n  * `configurationInProgress`: Configuration in progress\n  * `deviceDisabled`: Device is turned off\n  * `disconnectedFromBridge`: Disconnected from bridge\n\nAnalog Camera:\n  * `analogNoPower`: Power loss detected\n  * `analogBadSignal`: Signal quality issue\n  * `analogIncompatibleSignal`: Incompatible signal\n  * `analogNoSignal`: No signal\n  * `disconnectedFromBridge`: Disconnected from bridge\n  * `deviceDisabled`: Device is turned off\n\nManaged Switch:\n  * `deviceSupportIssue`: Switch support issue\n  * `disconnectedFromBridge`: Disconnected from bridge\n",
      "x-een-device-type-error-status-mapping": {
        "onvifCamera": [
          "generalDeviceError",
          "networkError",
          "invalidCredentials",
          "deviceSupportIssue",
          "queuedForConfiguration",
          "configurationInProgress",
          "deviceDisabled",
          "disconnectedFromBridge"
        ],
        "rtspCamera": [
          "generalDeviceError",
          "networkError",
          "invalidCredentials",
          "deviceSupportIssue",
          "queuedForConfiguration",
          "configurationInProgress",
          "deviceDisabled",
          "disconnectedFromBridge"
        ],
        "analogCamera": [
          "analogNoPower",
          "analogBadSignal",
          "analogIncompatibleSignal",
          "analogNoSignal",
          "disconnectedFromBridge",
          "deviceDisabled"
        ],
        "multiCamera": [
          "generalDeviceError",
          "networkError",
          "invalidCredentials",
          "deviceSupportIssue",
          "queuedForConfiguration",
          "configurationInProgress",
          "deviceDisabled",
          "disconnectedFromBridge"
        ],
        "managedSwitch": [
          "deviceSupportIssue",
          "disconnectedFromBridge"
        ]
      },
      "type": "string",
      "enum": [
        "disconnectedFromBridge",
        "generalDeviceError",
        "networkError",
        "invalidCredentials",
        "deviceSupportIssue",
        "queuedForConfiguration",
        "configurationInProgress",
        "deviceDisabled",
        "analogNoPower",
        "analogBadSignal",
        "analogIncompatibleSignal",
        "analogNoSignal"
      ]
    },
    "DeviceNotes": {
      "type": "string",
      "maxLength": 5000
    },
    "DeviceStatus": {
      "description": "Indicates various aspects of the device's status. The statuses defined here should be in sync with the events schema defined for the Device Cloud Status Update.",
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "connectionStatus": {
          "$ref": "#/$defs/DeviceConnectionStatus"
        }
      }
    },
    "DeviceStatusV2": {
      "description": "Status as reported by the edge device.",
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "cloudConnectionStatus": {
          "$ref": "#/$defs/deviceCloudConnectionStatusV2"
        },
        "edgeReportedDeviceStatus": {
          "$ref": "#/$defs/DeviceCommonStatus"
        },
        "deviceSpecificError": {
          "$ref": "#/$defs/DeviceErrorStatus"
        }
      },
      "required": [
        "cloudConnectionStatus",
        "edgeReportedDeviceStatus"
      ]
    },
    "DeviceTags": {
      "type": "array",
      "maxItems": 64,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 64
      }
    },
    "EffectiveMulticameraPermissions": {
      "readOnly": true,
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "properties": {
        "read": {
          "type": "boolean"
        },
        "delete": {
          "type": "boolean"
        },
        "edit": {
          "type": "boolean"
        }
      }
    },
    "Guid3": {
      "type": "string",
      "format": "uuid"
    },
    "IpAddress": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(?:25[0-5]|2[0-4]\\d|[0-1]?\\d{1,2})(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d{1,2})){3}$"
    },
    "IpUsedByBridge": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^(?:25[0-5]|2[0-4]\\d|[0-1]?\\d{1,2})(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d{1,2})){3}$|(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?:(?::[0-9a-fA-F]{1,4}){1,6})|:(?:(?::[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(?::[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(?::0{1,4}){0,1}:){0,1}(?:(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[0-9a-fA-F]{1,4}:){1,4}:(?:(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3,3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)",
      "description": "The current IP address the bridge is using, in IPv4 or IPv6 format."
    },
    "LocationId": {
      "description": "ID Of the location.",
      "minLength": 1,
      "type": [
        "string",
        "null"
      ]
    },
    "LocationSummary": {
      "type": "object",
      "x-jsoninclude-nonnull-annotation": true,
      "description": "Summary of location information.",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "address": {
          "type": "object",
          "properties": {
            "country": {
              "type": [
                "string",
                "null"
              ]
            },
            "region": {
              "type": [
                "string",
                "null"
              ]
            },
            "city": {
              "type": [
                "string",
                "null"
              ]
            },
            "streetAddress": {
              "type": [
                "string",
                "null"
              ]
            },
            "streetAddress2": {
              "type": [
                "string",
                "null"
              ]
            },
            "postalCode": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        }
      }
    },
    "MacAddress": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^([A-F0-9]{2}:){5}[A-F0-9]{2}$"
    },
    "PaginatedResponseNoTotalSize": {
      "type": "object",
      "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages.\n",
      "properties": {
        "nextPageToken": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true,
          "description": "Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.\n"
        },
        "prevPageToken": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true,
          "description": "Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.\n"
        },
        "results": {
          "type": "array",
          "readOnly": true,
          "description": "The result set from a collection API call.",
          "items": {
            "type": "object"
          }
        }
      },
      "required": [
        "nextPageToken",
        "prevPageToken",
        "results"
      ]
    },
    "PaginatedResponseWithSize": {
      "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages and  the total number of results.  \n",
      "allOf": [
        {
          "$ref": "#/$defs/PaginatedResponseNoTotalSize"
        },
        {
          "properties": {
            "totalSize": {
              "type": "integer",
              "readOnly": true,
              "description": "Size of the total result set.\n"
            }
          },
          "required": [
            "totalSize"
          ]
        }
      ]
    },
    "deviceCloudConnectionStatusV2": {
      "description": "Socket connection state between device and cloud\n  * `connected`: The device socket connected to cloud.\n  * `disconnected`: The device socket disconnected from cloud.\n",
      "type": "string",
      "enum": [
        "connected",
        "disconnected"
      ]
    }
  }
}