Webex · Schema

SuggestedEmergencyAddressObject

Object containing suggested address details.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
address1	string	Primary street information for the emergency address.
address2	string	Apartment number or any other secondary information for the emergency address.
city	string	City for the emergency address.
state	string	State or Province or Region for the emergency address.
postalCode	string	Postal code for the emergency address.
country	string	Country for the emergency address.
meta	object	Additional metadata for the emergency address.
errors	array	List of errors encountered during address validation. Returned only when the input address was corrected and a suggested address was provided. Each error describes a specific issue with the original i

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SuggestedEmergencyAddressObject",
  "title": "SuggestedEmergencyAddressObject",
  "type": "object",
  "description": "Object containing suggested address details.",
  "properties": {
    "address1": {
      "type": "string",
      "example": "3487 Chase Ave",
      "description": "Primary street information for the emergency address."
    },
    "address2": {
      "type": "string",
      "example": "Apt 112",
      "description": "Apartment number or any other secondary information for the emergency address."
    },
    "city": {
      "type": "string",
      "example": "Miami Beach",
      "description": "City for the emergency address."
    },
    "state": {
      "type": "string",
      "example": "FL",
      "description": "State or Province or Region for the emergency address."
    },
    "postalCode": {
      "type": "string",
      "example": "33140",
      "description": "Postal code for the emergency address."
    },
    "country": {
      "type": "string",
      "example": "US",
      "description": "Country for the emergency address."
    },
    "meta": {
      "type": "object",
      "description": "Additional metadata for the emergency address.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "houseNumber": "3487",
        "streetName": "Chase Ave",
        "country": "US",
        "state": "FL",
        "city": "Miami Beach",
        "zipCode": "33140",
        "latitude": "55.21913",
        "longitude": "-118.80616"
      }
    },
    "errors": {
      "type": "array",
      "description": "List of errors encountered during address validation. Returned only when the input address was corrected and a suggested address was provided. Each error describes a specific issue with the original input.",
      "items": {
        "$ref": "#/components/schemas/AddressLookupErrorObject"
      },
      "example": [
        {
          "code": "PMP4004",
          "title": "INVALID_STREET_ADDRESS",
          "detail": "The street address provided is invalid."
        }
      ]
    }
  }
}