PhoneNumberLocalities

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-phone-number-localities-schema.json",
  "title": "PhoneNumberLocalities",
  "description": "Represents a wrapper around a list of cities or towns.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-communication-services-browse-for-available-countries-cities-and-area-codes-api-openapi.yml#/components/schemas/PhoneNumberLocalities",
  "type": "object",
  "properties": {
    "phoneNumberLocalities": {
      "description": "Represents the underlying list of localities, e.g. cities or town.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/PhoneNumberLocality"
      }
    },
    "nextLink": {
      "description": "Represents the URL link to the next page.",
      "type": "string"
    }
  },
  "$defs": {
    "PhoneNumberAdministrativeDivision": {
      "description": "Represents an administrative division. e.g. state or province.",
      "required": [
        "abbreviatedName",
        "localizedName"
      ],
      "type": "object",
      "properties": {
        "localizedName": {
          "description": "Represents the localized name of the administrative division of the locality. e.g. state or province localized name.",
          "type": "string"
        },
        "abbreviatedName": {
          "description": "Represents the abbreviated name of the administrative division of the locality. e.g. state or province abbreviation such as WA (Washington).",
          "type": "string"
        }
      }
    },
    "PhoneNumberLocality": {
      "description": "Represents a locality.",
      "required": [
        "localizedName"
      ],
      "type": "object",
      "properties": {
        "localizedName": {
          "description": "Represents the localized name of the locality.",
          "type": "string"
        },
        "administrativeDivision": {
          "$ref": "#/$defs/PhoneNumberAdministrativeDivision"
        }
      }
    }
  }
}