GetCityStateProvinceAPIRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/precisely-apis/main/json-schema/precisely-apis-get-city-state-province-apirequest-schema.json",
  "title": "GetCityStateProvinceAPIRequest",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/precisely-apis-getcitystateprovince-api-openapi.yml#/components/schemas/GetCityStateProvinceAPIRequest",
  "properties": {
    "options": {
      "$ref": "#/$defs/GetCityStateProvinceAPIOptions"
    },
    "Input": {
      "$ref": "#/$defs/GetCityStateProvinceAPIInput"
    }
  },
  "type": "object",
  "$defs": {
    "GetCityStateProvinceAPIInput": {
      "properties": {
        "Row": {
          "items": {
            "$ref": "#/$defs/GetCityStateProvinceAPIInputRow"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "GetCityStateProvinceAPIInputRow": {
      "properties": {
        "user_fields": {
          "description": "These fields are returned, unmodified, in the user_fields section of the response.",
          "items": {
            "$ref": "#/$defs/GetPostalCodesAPIOutput_user_fields"
          },
          "type": "array"
        },
        "PostalCode": {
          "description": "The validated ZIP Code or postal code.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "GetCityStateProvinceAPIOptions": {
      "properties": {
        "OutputVanityCity": {
          "default": "N",
          "description": "Output VanityCity.",
          "type": "string"
        },
        "PerformCanadianProcessing": {
          "default": "Y",
          "description": "PerformCanadianProcessing.",
          "type": "string"
        },
        "MaximumResults": {
          "default": "10",
          "description": "MaximumResults.",
          "type": "string"
        },
        "PerformUSProcessing": {
          "default": "Y",
          "description": "PerformUSProcessing.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "GetPostalCodesAPIOutput_user_fields": {
      "properties": {
        "name": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}