HierarchyElementGeneral

A generalised component of a place hierarchy, that forms one element in the tree-like hierarchy. This forms a reusable block of the hierarchy, with relations to its parent element (if one exists) and any child elements. Each Place element in the hierarchy shall have a name, and may support a free-text description and an operator/property owner defined reference (e.g. location number/identifier)

idstringrequired

Unique identifier for object

Possible values: non-empty

versionintegerrequired

Positive integer representing the object version

Possible values: >= 1

name object[]required

Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

Possible values: >= 1

Array [

languageLanguageCode (string)required

ISO 639-1:2002 language code

Possible values: Value must match regular expression ^[a-z]{2}$

Example: en

stringstringrequired

Translated string

]

description object[]

Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

Possible values: >= 1

Array [

languageLanguageCode (string)required

ISO 639-1:2002 language code

Possible values: Value must match regular expression ^[a-z]{2}$

Example: en

stringstringrequired

Translated string

]

layerintegerrequired

Indicator of the position of this hierarchy element in the specific hierarchy, with the top of the hierarchy numbered layer 0.

Possible values: >= 0

typeHierarchyElementTypeEnum (string)required

Defines the supported lists of types of parking hierarchy elements permissible

campus: a data structure holding information about a large, often ill-defined area, which may contain many parking structures.
identifiedArea: a data structure holding information about a coherent feature, such as a set of parking spaces that all share the same characteristics
parkingPlace: a data structure holding information about a single identifiable facility
space: a data structure holding information about a single space for parking, usually designed for one vehicle, which may be denoted by painted or other road surface markers
subplaceElement: a reusable data structure holding information about a collection of IdentifiableAreas

Possible values: [campus, identifiedArea, parkingPlace, space, subplaceElement]

aliasesarray[]

Alternative names for the hierarchy element

Possible values: >= 1

parentId object

A reference to an identifiable version managed object where the combination of the identifier and version is unique. It comprises an identifier (e.g. GUID), a version (NonNegativeInteger) and a string identifying the class of the referenced object.

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

childIds object[]

The identity of one or several child nodes directly related to this hierarchy element.

Array [

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

]

operatorDefinedReference object[]

Multilingual string, represented as an array of SpecificLanguageString objects, each containing a language code (using ISO 639-1:2002) and the translated string

Possible values: >= 1

Array [

languageLanguageCode (string)required

ISO 639-1:2002 language code

Possible values: Value must match regular expression ^[a-z]{2}$

Example: en

stringstringrequired

Translated string

]

hierarchyElementRecord objectrequired

A collection of information concerning the creation of a hierarchy element

creationTimestring<date-time>required

Date/time that this version of the place facility record was created.

creator object

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

creatorEmailstring<email>

rightSpecifications object[]

RightSpecifications associated to the element

Array [

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

]

hierarchyElementReference object

A class providing a unique reference identifier for a discrete part of the parking place hierarchy. This can indicate a campus, parking place, hierarchy element, identifiable area or space.

elementId objectrequired

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

demandTable object[]

Array [

frequencyDuration (string)

ISO8601 format definition of an interval of time - format [PnnYnnMnnDTnnHnnMnnS]

Possible values: Value must match regular expression ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$

timestampstring<date-time>

Timestamp when the demand table data was compiled.

demandType object[]

Occupancy for area

Array [

countinteger

Number of occupied spaces.

Possible values: >= 0

occupancyCalculationCalculationTypeEnum (string)

A list of the supported calculation types for demand.

counted: Physical determination if a space is occupied
derived: Space occupancy is estimated by using related data such as active payments or sold permits.
expected: Future prediction of occupancy levels.
verified: Defines an occupancy report that is considered a verified report.

Possible values: [counted, derived, expected, verified]

percentagenumber<float>

Percent of spaces occupied.

Possible values: >= 0 and <= 100

recordDateTimestring<date-time>required

When data in the record was compiled.

]

demandSpaceType object[]

Occupancy for single spaces

Array [

detectionUpdateTimestring<date-time>required

Time of update, from detector.

occupancyEndTimestring<date-time>

The actual Time space is vacated.

occupancyEstimatedEndTimestring<date-time>

The estimated time a space is expected to be vacated.

occupancyEstimatedStartTimestring<date-time>

The estimated time a space is expected to be occupied.

occupancyStartTimestring<date-time>

The actual time space is occupied

spaceId object

A reference to an identifiable managed object where the identifier is unique. It is composed of a string identifying the class of the referenced object and a unique string identifier.

classNamestringrequired

The class name of the referenced object in PascalCase

Possible values: non-empty

Example: UKNumberPlate

idstringrequired

The unique identifier within the given class

Example: LA51ABC

occupancyLevel object

Defines an occupancy level as specified by the data supplier.

occupancyIndicator objectrequired

Class providing structure to support reference to an entry in a previously defined user-defined code list.

codeListEntryId object

A reference to an identifiable managed object where the identifier is unique. It is composed of a string identifying the class of the referenced object and a unique string identifier.

classNamestringrequired

The class name of the referenced object in PascalCase

Possible values: non-empty

Example: UKNumberPlate

idstringrequired

The unique identifier within the given class

Example: LA51ABC

codeListId object

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

entryDefinedValuestringrequired

free-text defined text (name) for the code list entry being referenced

]

supply object[]

Array [

supplyViewTypeSupplyViewTypeEnum (string)required

Define if space quantity is demarcated or estimated.

spaceView: Each space is physically marked and identifiable.
vehicleView: The vehicle capacity in an area is estimated based on calculating a capacity (i.e. curb length divided by a length of vehicle). The distributing party decides on the appropriate length of vehicle to use.

Possible values: [spaceView, vehicleView]

supplyQuantityintegerrequired

Indicates the numeric value of available parking or other space uses.

supplyValidityStartstring<date-time>

Valid start date/time for the supply

supplyValidityEndstring<date-time>

Valid end date/time for the supply

]

occupancyLevel object

Defines an occupancy level as specified by the data supplier.

occupancyIndicator objectrequired

Class providing structure to support reference to an entry in a previously defined user-defined code list.

codeListEntryId object

A reference to an identifiable managed object where the identifier is unique. It is composed of a string identifying the class of the referenced object and a unique string identifier.

classNamestringrequired

The class name of the referenced object in PascalCase

Possible values: non-empty

Example: UKNumberPlate

idstringrequired

The unique identifier within the given class

Example: LA51ABC

codeListId object

idstringrequired

Unique identifier

Possible values: non-empty

versionintegerrequired

Version number

Possible values: >= 1

classNamestring

Class name of the referenced object. It's optional, as it might be implied by the attribute name using this reference

Possible values: Value must match regular expression ^([A-Z][a-z0-9]+)+

entryDefinedValuestringrequired

free-text defined text (name) for the code list entry being referenced

HierarchyElementGeneral
{
  "id": "string",
  "version": 0,
  "name": [
    {
      "language": "en",
      "string": "string"
    }
  ],
  "description": [
    {
      "language": "en",
      "string": "string"
    }
  ],
  "layer": 0,
  "type": "campus",
  "aliases": [
    {
      "language": "en",
      "string": "string"
    }
  ],
  "parentId": {
    "id": "string",
    "version": 0,
    "className": "string"
  },
  "childIds": [
    {
      "id": "string",
      "version": 0,
      "className": "string"
    }
  ],
  "operatorDefinedReference": [
    {
      "language": "en",
      "string": "string"
    }
  ],
  "hierarchyElementRecord": {
    "creationTime": "2024-07-29T15:51:28.071Z",
    "creator": {
      "id": "string",
      "version": 0,
      "className": "string"
    },
    "creatorEmail": "user@example.com"
  },
  "rightSpecifications": [
    {
      "id": "string",
      "version": 0,
      "className": "string"
    }
  ],
  "hierarchyElementReference": {
    "elementId": {
      "id": "string",
      "version": 0,
      "className": "string"
    },
    "demandTable": [
      {
        "frequency": "string",
        "timestamp": "2024-07-29T15:51:28.071Z",
        "demandType": [
          {
            "count": 0,
            "occupancyCalculation": "counted",
            "percentage": 0,
            "recordDateTime": "2024-07-29T15:51:28.071Z"
          }
        ],
        "demandSpaceType": [
          {
            "detectionUpdateTime": "2024-07-29T15:51:28.071Z",
            "occupancyEndTime": "2024-07-29T15:51:28.071Z",
            "occupancyEstimatedEndTime": "2024-07-29T15:51:28.071Z",
            "occupancyEstimatedStartTime": "2024-07-29T15:51:28.071Z",
            "occupancyStartTime": "2024-07-29T15:51:28.071Z",
            "spaceId": {
              "className": "UKNumberPlate",
              "id": "LA51ABC"
            },
            "occupancyLevel": {
              "occupancyIndicator": {
                "codeListEntryId": {
                  "className": "UKNumberPlate",
                  "id": "LA51ABC"
                },
                "codeListId": {
                  "id": "string",
                  "version": 0,
                  "className": "string"
                },
                "entryDefinedValue": "string"
              }
            }
          }
        ]
      }
    ],
    "supply": [
      {
        "supplyViewType": "spaceView",
        "supplyQuantity": 0,
        "supplyValidityStart": "2024-07-29T15:51:28.071Z",
        "supplyValidityEnd": "2024-07-29T15:51:28.071Z"
      }
    ]
  },
  "occupancyLevel": {
    "occupancyIndicator": {
      "codeListEntryId": {
        "className": "UKNumberPlate",
        "id": "LA51ABC"
      },
      "codeListId": {
        "id": "string",
        "version": 0,
        "className": "string"
      },
      "entryDefinedValue": "string"
    }
  }
}