PropertyActivityAPI.v1.PortfolioDetails

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/domain-group/main/json-schema/domain-group-property-activity-api-v1-portfolio-details-schema.json",
  "title": "PropertyActivityAPI.v1.PortfolioDetails",
  "description": "Portfolio Details",
  "x-generated": "2026-10-21",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/domain-group-propertyradar-api-openapi.yml#/components/schemas/PropertyActivityAPI.v1.PortfolioDetails",
  "type": "object",
  "anyOf": [
    {
      "required": [
        "PropertyIds"
      ]
    },
    {
      "required": [
        "GnafIds"
      ]
    }
  ],
  "properties": {
    "PropertyIds": {
      "maxItems": 5000,
      "type": "array",
      "items": {
        "pattern": "^[A-Z]{2}-\\d{4}-[A-Z]{2}$",
        "type": "string"
      },
      "description": "Array of property id's in format XX-9999-XX"
    },
    "GnafIds": {
      "maxItems": 5000,
      "type": "array",
      "items": {
        "pattern": "^\\S+$",
        "type": "string"
      },
      "description": "Array of gnaf id's"
    }
  },
  "additionalProperties": false
}