Schemas / Person / organisation / party

rig.person.contact

v0.31.0 · draft 5 fields 0 required

Fields

FieldTypeMeaning
email string optional Mailbox
phone string optional Voice number
mobile string optional Mobile number
fax string optional Fax number
preferredMethod enummail · email · phone · mobile · fax optional mail / email / phone / mobile / fax

Reach channels for a human, character, user, or contact. Format when present.

Field meanings follow the ISO 20022 ContactDetails type used inside financial MX messages. This schema is those telecom / mailbox elements - not a postal address, not employment, and not the person record itself.

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

Prefer E.164 for phone, mobile, and fax when the source has it (+61412345678). National formats stay valid strings - do not invent a second field.

Postal / civic fields are rig.place.address. A map pin is rig.place.geo. Job title, department, and organisation are rig.person.employment. Name the person with rig.meta.named plus rig.person.name. Do not re-declare those here.

JSON Schema

Resolves at https://rig.works/schemas/rig.person.contact.schema.jsonraw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.person.contact.schema.json",
  "title": "rig.person.contact",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "email": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "phone": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "mobile": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "fax": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "preferredMethod": {
      "type": "string",
      "enum": [
        "mail",
        "email",
        "phone",
        "mobile",
        "fax"
      ]
    }
  },
  "description": "Reach channels. Field meanings follow ISO 20022 ContactDetails. Not a postal address.",
  "minProperties": 1
}

Seen in

calendar-event.json · person-contact.json