Schemas / Place (civic / postal)

`rig.place.address`

v0.31.0 · draft 14 fields 0 required

Fields

Field	Type		Meaning
`streetName`	string	optional	Thoroughfare name
`buildingNumber`	string	optional	Premise number (`12A`, not an int)
`buildingName`	string	optional	Premise name
`floor`	string	optional	Floor / level
`room`	string	optional	Unit / suite / room
`postBox`	string	optional	Delivery-service box
`postCode`	string	optional	Postal code
`townName`	string	optional	Town / city
`townLocationName`	string	optional	Suburb / locality qualifier
`districtName`	string	optional	District
`countrySubDivision`	string	optional	State / province
`country`	string	optional	ISO 3166-1 alpha-2, uppercase
`department`	string	optional	Organisation unit at the place
`subDepartment`	string	optional	Nested organisation unit

Civic / postal address of a place. Format when present.

Field meanings follow UPU S42 international postal address elements and the ISO 20022 PostalAddress type used inside financial MX messages. This schema is that shared element set - not an MX message (pain.*, pacs.*, camt.*), not a payment, and not scene pose.

All fields optional. Emit what the source has; omit empty strings. An empty component is invalid - attach at least one field.

Name the place by composing rig.meta.named. Nest site, building, floor, room with rig.spatial.relationship. Drawing pose is rig.spatial.transform. A map pin is rig.place.geo. A person's postal address is this same schema composed onto the person entity - see rig.person.name. Do not re-declare those here.

Unstructured ISO 20022 AdrLine / free-text blobs stay in the database. The importer maps them into these fields. Do not dual-author structured fields and address lines.

Mail-only MX slots (AdrTp, CareOf, recipient / mailee) are not site data - leave them in the source system.

JSON Schema

Resolves at https://rig.works/schemas/rig.place.address.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.place.address.schema.json",
  "title": "rig.place.address",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "streetName": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "buildingNumber": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "buildingName": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "floor": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "room": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "postBox": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "postCode": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "townName": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "townLocationName": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "districtName": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "countrySubDivision": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "description": "ISO 3166-1 alpha-2 (ISO 20022 Ctry)."
    },
    "department": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "subDepartment": {
      "$ref": "./_defs.schema.json#/$defs/string"
    }
  },
  "description": "Civic / postal address. Field meanings follow UPU S42 and ISO 20022 PostalAddress. Not scene pose.",
  "minProperties": 1
}

Seen in

art-object.json · book-isbn.json · calendar-event.json · person-contact.json · place-address.json