id.sifa.profile.location Documentation (EN)

main record

A single location entry in the user's profile.

Record Key tid Timestamp-based ID

Properties

address ref community.lexicon.location.address Required

Structured location address. Sifa enforces ISO 3166-1 alpha-2 country codes at the app layer.

createdAt string datetime Required

Client-declared timestamp when this record was created.

isPrimary boolean Optional

Whether this is the primary/display location.

label string Optional

Optional user-defined label for this location.

maxLength: 600 bytesmaxGraphemes: 60 graphemes

type string Required

The role of this location.

Known values: id.sifa.defs#locationPrimary, id.sifa.defs#locationBusiness, id.sifa.defs#locationTravel

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "address",
      "type",
      "createdAt"
    ],
    "properties": {
      "type": {
        "type": "string",
        "description": "The role of this location.",
        "knownValues": [
          "id.sifa.defs#locationPrimary",
          "id.sifa.defs#locationBusiness",
          "id.sifa.defs#locationTravel"
        ]
      },
      "label": {
        "type": "string",
        "maxLength": 600,
        "description": "Optional user-defined label for this location.",
        "maxGraphemes": 60
      },
      "address": {
        "ref": "community.lexicon.location.address",
        "type": "ref",
        "description": "Structured location address. Sifa enforces ISO 3166-1 alpha-2 country codes at the app layer."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Client-declared timestamp when this record was created."
      },
      "isPrimary": {
        "type": "boolean",
        "description": "Whether this is the primary/display location."
      }
    }
  },
  "description": "A single location entry in the user's profile."
}