DemandTable

Table structure which defines the parameters of reporting actual usage of parking in a Hierarchy Element

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

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]+)+

entryDefinedValuestringrequired

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

]

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"
        }
      }
    }
  ]
}