Skip to main content

Postal Address

A physical mailing address.

This type is an implementation of schema:PostalAddress.

Properties#

Name@idTypeDescriptionInherited from
addressCountryschema:addressCountrystringThe country. See note 1.PostalAddress
addressLocalityschema:addressLocalitystringThe locality in which the street address is, and which is in the region. See note 2.PostalAddress
addressRegionschema:addressRegionstringThe region in which the locality is, and which is in the country. See note 3.PostalAddress
alternateNamesschema:alternateNameArray of stringAlternate names (aliases) for the item.Thing
availableLanguagesschema:availableLanguageArray of stringLanguages (human not programming) in which it is possible to communicate with the organization/department etc.ContactPoint
descriptionschema:descriptionArray of BlockContent or Array of InlineContent or stringA description of the item. See note 4.Thing
emailsschema:emailArray of Format 'email'Email address for correspondence.ContactPoint
idschema:idstringThe identifier for this item.Entity
identifiersschema:identifierArray of (PropertyValue or string)Any kind of identifier for any kind of Thing. See note 5.Thing
imagesschema:imageArray of (ImageObject or Format 'uri')Images of the item.Thing
metastencila:metaobjectMetadata associated with this item.Entity
nameschema:namestringThe name of the item.Thing
postOfficeBoxNumberschema:postOfficeBoxNumberstringThe post office box number.PostalAddress
postalCodeschema:postalCodestringThe postal code. See note 6.PostalAddress
streetAddressschema:streetAddressstringThe street address. See note 7.PostalAddress
telephoneNumbersschema:telephoneArray of stringTelephone numbers for the contact point.ContactPoint
urlschema:urlFormat 'uri'The URL of the item.Thing

Notes#

  1. addressCountry : !array('For example, United Kingdom. You can also provide the two-letter ISO 3166-1 alpha-2 country code.')
  2. addressLocality : !array('For example, London.')
  3. addressRegion : !array('For example, California or another appropriate first-level Administrative division')
  4. description : !array('Allows for the description to be an array of nodes (e.g. an array of inline content, or a couple of paragraphs), or a string. The ')minItems!array(' restriction avoids a string being coerced into an array with a single string item.')
  5. identifiers : !array('Some identifiers have specific properties e.g the ')issn!array(' property for the ')Periodical!array(' type. These should be used in preference to this property which is intended for identifiers that do not yet have a specific property. Identifiers can be represented as strings, but using a ')PropertyValue!array(' will usually be better because it allows for ')propertyID!array(' (i.e. the type of identifier).')
  6. postalCode : !array('For example, 94043.')
  7. streetAddress : !array('For example, 10 Downing Street.')

Related#

Available as#

Source#

This documentation was generated from PostalAddress.schema.yaml.