API Docs for: 1.3.12
Show:

PostalAddress Class

Schema.org/PostalAddress The mailing address.

Methods

getDescription

() String
Returns the description of the thing

Returns:

String: description of Thing

getName

() String
Returns the name of the thing

Returns:

String: name of Thing

setDescription

(
  • description
)
Method to set Thing description

Parameters:

  • description String
    Description to set for its Thing

setName

(
  • name
)
Method to set Thing name

Parameters:

  • name String
    Name to set for this Thing

Properties

additionalType

URL
Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

addressCountry

LangString

http://purl.org/ctdl/terms/addressCountry Nation with its own government and occupying a particular territory identified by the two-letter ISO 3166-1 alpha-2 country code.

addressCountry

Text

Schema.org/addressCountry The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.

addressLocality

LangString

http://purl.org/ctdl/terms/addressLocality Town, city, or village in which a particular location is situtated.

addressLocality

Text

Schema.org/addressLocality The locality. For example, Mountain View.

addressRegion

LangString

http://purl.org/ctdl/terms/addressRegion State or province in which a particular location is situtated.

addressRegion

Text

Schema.org/addressRegion The region. For example, CA.

alternateName

Text
Schema.org/alternateName An alias for the item.

areaServed

Place

Schema.org/areaServed The geographic area where a service or offered item is provided.

availableLanguage

Language

Schema.org/availableLanguage A language someone may use with the item. Please use one of the language codes from the IETF BCP 47 standard. See also [[inLanguage]]

contactOption

ContactPointOption

Schema.org/contactOption An option available on this contact point (e.g. a toll-free number or support for hearing-impaired callers).

contactType

LangString

http://purl.org/ctdl/terms/contactType Text identifying the type of service provided by an organizational contact. A person or organization may have different contact points for different services. The contact type property provides for adding text to identity the service; e.g., "toll-free number" or "support for hearing-impaired callers".

description

Text
Schema.org/description A description of the item.

disambiguatingDescription

Text
Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

email

String

http://purl.org/ctdl/terms/email Email address of the organization or person.

faxNumber

String

hoursAvailable

OpeningHoursSpecification

Schema.org/hoursAvailable The hours during which this service or contact is available.

identifier

Schema, URL | schema,Text | schema,PropertyValue
Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

image

Schema, URL | schema,ImageObject
Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork
Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.

name

LangString

http://purl.org/ctdl/terms/name Name or title of the entity.

postalCode

Text

Schema.org/postalCode The postal code. For example, 94043.

postalCode

String

http://purl.org/ctdl/terms/postalCode The postal code. For example, 94043.

postOfficeBoxNumber

Text

Schema.org/postOfficeBoxNumber The post office box number for PO box addresses.

postOfficeBoxNumber

String

http://purl.org/ctdl/terms/postOfficeBoxNumber Post office box number for post office addresses.

potentialAction

Action
Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

productSupported

Text

Schema.org/productSupported The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones").

sameAs

URL
Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

serviceArea

GeoShape

Schema.org/serviceArea The geographic area where the service is provided.

socialMedia

AnyURI

http://purl.org/ctdl/terms/socialMedia Social media access point for an agent or an agent's contact point.

streetAddress

Text

Schema.org/streetAddress The street address. For example, 1600 Amphitheatre Pkwy.

streetAddress

LangString

http://purl.org/ctdl/terms/streetAddress Street address. e.g. "1600 Amphitheatre Pkwy".

telephone

String

url

URL
Schema.org/url URL of the item.