SiteList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adt/refs/heads/main/json-schema/business-api-site-list-schema.json",
  "title": "SiteList",
  "description": "List of business sites.",
  "type": "object",
  "properties": {
    "sites": {
      "type": "array",
      "description": "Array of business sites.",
      "items": {
        "type": "object",
        "description": "A business site with ADT security systems.",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the site.",
            "example": "site-001"
          },
          "name": {
            "type": "string",
            "description": "Name of the business site.",
            "example": "Downtown Office"
          },
          "address": {
            "type": "string",
            "description": "Physical address.",
            "example": "456 Business Ave, Citytown, CA 90210"
          },
          "status": {
            "type": "string",
            "description": "Current security status.",
            "enum": [
              "armed",
              "disarmed",
              "alarm"
            ],
            "example": "armed"
          },
          "systemCount": {
            "type": "integer",
            "description": "Number of security systems at this site.",
            "example": 3
          }
        }
      }
    },
    "total": {
      "type": "integer",
      "description": "Total number of sites.",
      "example": 5
    }
  }
}