Types

Organization

Example

{
  "type": "string",
  "address": {
    "type": "PostalAddress",
    "streetAddress": "1007 Mountain Gate Rd",
    "postOfficeBoxNumber": "Box 1234",
    "addressRegion": "NJ",
    "addressLocality": "Gotham City",
    "postalCode": "10010",
    "addressCountry": "CA",
    "addressCounty": "string",
    "addressSubdivision": "Gotham Heights"
  },
  "availableLanguage": [
    {
      "type": "Language",
      "name": "English",
      "additionalName": "en-us"
    }
  ],
  "branchCode": "for BHHS profile events, see additionalProperty.OfficeId",
  "certification": [
    {
      "type": "Certification",
      "name": "e-Agent Certified",
      "issuedBy": {
        "type": "RealEstateOrganization",
        "id": "https://example.com/profile/card#me",
        "name": "Gotham City Real Estate"
      },
      "issuedTo": {
        "type": "RealEstateAgent",
        "id": "http://example.com",
        "name": "string"
      }
    }
  ],
  "contactPoint": [
    {
      "type": "ContactPoint",
      "name": "Work",
      "telephone": "555-555-5555",
      "faxNumber": "555-555-5555",
      "email": "bob@example.com",
      "url": "https://www.facebook.com/hallandoates"
    }
  ],
  "email": "user@example.com",
  "faxNumber": "string",
  "image": [
    {
      "type": "ImageObject",
      "@id": "http://example.com",
      "id": "http://user.example.com/public/logo/image.jpg",
      "name": "image.jpg",
      "encodingFormat": "image/jpeg",
      "about": "http://user.example.com/profile/card#me",
      "url": "http://user.example.com/public/profile/image.jpg"
    }
  ],
  "logo": [
    {
      "type": "DigitalDocument",
      "id": "http://user.example.com/public/logo/archive.zip",
      "name": "archive.zip",
      "encodingFormat": "application/zip",
      "about": {
        "type": "RealEstateTransaction",
        "identifier": {
          "bmsTransactionId": "xxxx"
        }
      },
      "url": "https://example.com"
    }
  ],
  "name": "string",
  "parentOrganization": [
    "http://example.com"
  ],
  "subOrganization": [
    "http://example.com"
  ],
  "telephone": "+15558675309",
  "url": "http://example.com"
}

Schema

NameTypeDescription
(root)object-
typestring-
addressobjectA physical address.
address.typestringconst ("PostalAddress")
address.streetAddressstringthe street address <= 75 characters
address.postOfficeBoxNumberstringThe post office box number for PO box addresses.
address.addressRegionstringabbreviated state or province
address.addressLocalitystringCity, Township. <= 50 characters
address.postalCodestringZip/Post Code <= 12 characters
address.addressCountrystringallowed ("CA", "DE", "GR", "IN", "IT", "MX", "PE", "PT", "ES", "AE", "GB", "US") two-letter ISO 3166-1 alpha-2 country code
address.addressCountystringCounty
address.addressSubdivisionstringthe subdivision or neighborhood (us real estate extension)
availableLanguagearray<object>Please use one of the language codes from the IETF BCP 47 standard.
availableLanguage.typestringconst ("Language")
availableLanguage.namestringthe display name of the language
availableLanguage.additionalNamestringBCP 47 language code
branchCodestringA short textual code that uniquely identifies a place of business.
certificationtuple<object, ...optional<any>>certifications granted to a person or organization
certification.0 (index)objectA certification issued by an organization to an individual or business.
certification.0.typestringallowed ("Certification") Certification
certification.0.namestringthe name of the Certification
certification.0.issuedByobjectthe issuing authority
certification.0.issuedBy.typestringallowed ("RealEstateOrganization") The item type (Linked-Data @type)
certification.0.issuedBy.idstringLinked-Data URI (@id) format (uri)
certification.0.issuedBy.namestringname of the issuing organization
certification.0.issuedToobjectthe subject
certification.0.issuedTo.typestringallowed ("RealEstateAgent") The item type (Linked-Data @type)
certification.0.issuedTo.idstringLinked-Data URI (@id) format (uri)
certification.0.issuedTo.namestring-
contactPointarray<object>a named point of contact - telephone, email, faxNumber, and/or url for the entity
contactPoint.typestringconst ("ContactPoint")
contactPoint.namestringa label for the contactPoint, i.e. 'Work', or 'Home'
contactPoint.telephonestring-
contactPoint.faxNumberstring-
contactPoint.emailstringan email address for the item. format (email)
contactPoint.urlstringprimary URL for the item. format (uri)
emailstringa valid email address format (email)
faxNumberstringDo people still use fax machines?
imagetuple<object allOf, ...optional<any>>an ImageObject or URI reference to an image on the web.
image.0 (index)object allOf-
image.0.0 (allOf item)allOfan image, video or document availble for download
image.0.0.0 (allOf item)object-
image.0.0.0.typestringThe item type (Linked-Data @type) pattern (^[A-Z][a-zA-Z0-9]+$)
image.0.0.0.@idstringthe liked data uri for the Thing format (uri)
image.0.0.0 (property names)-pattern (^[a-z@$][a-zA-Z0-9-_]+$)
image.0.0.1 (allOf item)--
image.0.0.1.typestringallowed ("MediaObject", "ImageObject", "DigitalDocument")
image.0.0.1.idstringthe URL to access the item. format (uri)
image.0.0.1.namestringthe file name of the object.
image.0.0.1.encodingFormatstringMIME type
image.0.0.1.aboutstringURI to the subject of the image or logo format (uri)
image.0.0.1.urlstringURL of the image content format (uri)
image.0.1 (allOf item)--
image.0.1.typestringallowed ("ImageObject")
image.0.1.idany-
image.0.1.nameany-
image.0.1.encodingFormatany-
logoarray<object>-
logo.typestringallowed ("DigitalDocument")
logo.idstring-
logo.namestringdocument name or title
logo.encodingFormatstringISO Media Type
logo.aboutobjectsubject of the Document
logo.urlstringpublic URL of the object
namestring-
parentOrganizationarray<string>organizations of which this org is a part.
parentOrganization (single item)stringformat (uri)
subOrganizationarray<string>child organizations of the organization
subOrganization (single item)stringformat (uri)
telephonestringPrimary phone number.
urlstringURL of the item. format (uri)
Previous
OpenHouseEvent
Next
OrganizationRole