Location

Validate against: http://json-schema.org/draft-07/schema#

Schema ID: http://schemas.digitallinguistics.io/Location-3.3.0.json

Type: object

Description

A location, optionally with accompanying geographic coordinate data

Developer Notes

This is a top-level database object

Required Properties

  • name

Properties

The following properties are defined for this object:

  • Type: type

    Type: string

    Read-only: true

    Description

    The type of object. Must be set to Location.

    This item must have the following value:

    "Location"
  • ID: id

    Description

    A unique database identifier for this Location

  • Abbreviation: abbreviation

    Type: string

    Description

    An abbreviation for this Location

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Abbreviation.json

  • Access Rights: access

    Type: object

    Description

    Since locations sometimes contain personal information like addresses, it is important to consider the proper access management policy for them.

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Access.json

  • Address: address

    Type: object

    Description

    An address associated with this location

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Address.json

  • Date Created: dateCreated

    Type: string

    Description

    The date and optionally time that this Location object was created

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Modified: dateModified

    Type: string

    Description

    The date and optionally time that this Location was last modified

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • GeoJSON Geometry Object: geoJSON

    Type: object

    Description

    A GeoJSON object describing this Location. Must adhere to the GeoJSON format: http://geojson.org/.

    Referenced Schema

    This item must validate against the following schema:

    http://geojson.org/schema/GeoJSON.json

  • Link: link

    Type: string

    Description

    A URL where a presentational format for this resource may be viewed

    Format: uri

  • Name: name

    Description

    A name for this location, e.g. Susan’s House or Valley High School, or Shenandoah River, optionally in multiple languages. The name must be provided in at least one language.

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/MultiLangString.json

  • Notes: notes

    Type: array

    Description

    A collection of notes about this Location

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Note: notes

    Type: object

    Description

    A note about this location

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Note.json

  • Bibliographic References: references

    Type: array

    Description

    A collection of bibliographic references about this Location

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Reference: references

    Type: object

    Description

    A bibliographic reference about this location

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/BibliographicReference.json

  • Tags: tags

    Type: object

    Description

    A set of tags for this Location

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Tags.json

  • URL: url

    Type: string

    Description

    The URL where information about this location can be retrieved

    Format: uri

Additional Properties

Any additional properties must adhere to the following schema:

This schema imposes no restrictions. All values are valid.

Examples

The following are example values for this schema:

  • {
      "abbreviation": "Charenton",
      "access": {
        "notes": {
          "eng": "There are no restrictions on access to this location."
        }
      },
      "dateCreated": "2018-10-30T01:54:19.901Z",
      "dateModified": "2018-10-30T01:54:39.394Z",
      "geoJSON": {
        "type": "Point",
        "coordinates": [
          29.874408,
          -91.547868
        ]
      },
      "id": "ed15e19a-1ba0-437d-9adf-61f4cca1ff3a",
      "name": "Charenton",
      "notes": [
        {
          "text": "Built on the site of the Chitimacha village Kas Kec Namu.",
          "language": "eng"
        }
      ],
      "type": "Location",
      "url": "https://api.digitallinguistics.io/locations/Charenton"
    }
  • {
      "abbreviation": "Kisii",
      "dateCreated": "2018-10-30T01:54:19.901Z",
      "dateModified": "2018-10-30T01:54:39.394Z",
      "geoJSON": {
        "type": "Point",
        "coordinates": [
          -0.67677,
          34.77905
        ]
      },
      "id": "226118c2-3e03-40cd-ab4a-d4e832140408",
      "name": "Kisii",
      "type": "Location",
      "url": "https://api.digitallinguistics.io/locations/Kisii"
    }