city.atls.actor.location

atls.city

Documentation

Singleton record of the user's location tags.

main record

Singleton record of the user's location tags.

Record Key literal:self Fixed literal value

Properties

locations array of ref #locationEntry Required

The user's tagged locations (max 3).

maxLength: 3 items
updatedAt string datetime Required

Timestamp of the most recent change.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "locations",
      "updatedAt"
    ],
    "properties": {
      "locations": {
        "type": "array",
        "items": {
          "ref": "#locationEntry",
          "type": "ref"
        },
        "maxLength": 3,
        "description": "The user's tagged locations (max 3)."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp of the most recent change."
      }
    }
  },
  "description": "Singleton record of the user's location tags."
}
address object

A physical location (mirrors community.lexicon.location.address).

Properties

country string Required

ISO 3166 country code.

maxLength: 10 bytesminLength: 2 bytes
locality string Optional

City or town name.

name string Optional

Display name of the location.

region string Optional

Administrative region (e.g. state/province).

View raw schema 
{
  "type": "object",
  "required": [
    "country"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Display name of the location."
    },
    "region": {
      "type": "string",
      "description": "Administrative region (e.g. state/province)."
    },
    "country": {
      "type": "string",
      "maxLength": 10,
      "minLength": 2,
      "description": "ISO 3166 country code."
    },
    "locality": {
      "type": "string",
      "description": "City or town name."
    }
  },
  "description": "A physical location (mirrors community.lexicon.location.address)."
}
atlasKey string

Optional ATlas canonical location key (e.g. US-OR-Portland). When present, ATlas uses this for exact matching instead of fuzzy text matching. Look up valid keys at https://atls.city/api/locations/lookup

View raw schema 
{
  "type": "string",
  "description": "Optional ATlas canonical location key (e.g. US-OR-Portland). When present, ATlas uses this for exact matching instead of fuzzy text matching. Look up valid keys at https://atls.city/api/locations/lookup"
}
locationEntry object

No description available.

Properties

addedAt string datetime Optional

An RFC 3339 formatted timestamp.

address ref #address Required

Location in community.lexicon.location.address format.

atlasKey ref #atlasKey Optional

No description available.

isPrimary boolean Required

Whether this is the user's primary location.

osmId ref #osmId Optional

No description available.

osmType ref #osmType Optional

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "address",
    "isPrimary"
  ],
  "properties": {
    "osmId": {
      "ref": "#osmId",
      "type": "ref"
    },
    "addedAt": {
      "type": "string",
      "format": "datetime"
    },
    "address": {
      "ref": "#address",
      "type": "ref",
      "description": "Location in community.lexicon.location.address format."
    },
    "osmType": {
      "ref": "#osmType",
      "type": "ref"
    },
    "atlasKey": {
      "ref": "#atlasKey",
      "type": "ref"
    },
    "isPrimary": {
      "type": "boolean",
      "description": "Whether this is the user's primary location."
    }
  }
}
osmId integer

Optional OpenStreetMap node/relation ID for the location. Globally unique geographic identifier. See https://www.openstreetmap.org/node/{id} or /relation/{id}

View raw schema 
{
  "type": "integer",
  "description": "Optional OpenStreetMap node/relation ID for the location. Globally unique geographic identifier. See https://www.openstreetmap.org/node/{id} or /relation/{id}"
}
osmType string

OSM element type: node, way, or relation.

Known Values (other values may be valid)
node way relation
View raw schema 
{
  "type": "string",
  "description": "OSM element type: node, way, or relation.",
  "knownValues": [
    "node",
    "way",
    "relation"
  ]
}

Lexicon Garden

@