This section describes the structured data types which make up OS MasterMap Highways Network - Paths. The attributes associated with these data types are listed below along with a brief description of their data properties.

SpecialDesignations have a property of ‘timeInterval’ which has the type of ‘TemporalPropertyType’. The below table describes this data type and shows how it is made up. The hierarchical structure of Temporal Properties is shown on the Temporal Properties page.

Structured data type attribute information

Name and Definition

The name of the attribute and what it is describing.

Data type

The nature of the attribute, for example a numeric value or a code list value.

Size

The length of the attribute provided (optional).

Multiplicity

Describes how many times this element is expected to be populated in the data. An attribute may be optional or mandatory within the product. These are denoted by:

• ‘1’ – there must be a value.

• ‘0..1’ – population is optional but a maximum of one attribute will be returned These values may be used in combination.

Streets are attributed with a “designatedName” with a data type of “DesignatedNameType”. The attribution of this data type is detailed below.

DesignatedNameType attributes

The name assigned to the road or street by a designated Street Naming Authority.

name

Official name assigned to the highway by a designated Street Naming Authority.

• Attribute name: designatedName (GML), designated_name (GeoPackage), designated_name (Vector Tiles)

• Size: 255

• Multiplicity: [1]

namingAuthority

The Street Naming Authority for the designatedName.

• Attribute name: namingAuthority (GML), naming_authority (GeoPackage) Not provided (Vector Tiles)

• Type: ResponsibleAuthority

• Multiplicity: [1]

TemporalPropertyType attributes

The time period which a restriction is in place.

• Constraints: A TermporalPropertyType shall have at least one of namedDate, dateRange, or dayPeriod When namedDate = 'All Dates' no other values for namedDate or dateRange shall be populated

namedDate

The named month or period this time interval applies.

• Type: NamedDateValue

• Multiplicity: [0..*]

dateRange

The range of dates the time restriction is in place for.

• Type: DateRangeType

• Multiplicity: [0..*]

dayPeriod

A restriction which applies on a specified day.

• Type: DayPropertyType

• Multiplicity: [0..*]

The Identifier is an INSPIRE data type and its elements make up the “inspireId” attribute which can be found across all feature types in the OS MasterMap Highways Network.

Identifier attributes

External unique object identifier published by the responsible body, which may be used by external applications to reference the spatial object.

localId

The local identifier is unique within the namespace, that is no other spatial object carries the same unique identifier.

• Attribute name: localId (GML), local_id (GeoPackage), Not provided (Vector Tiles)

• Type: CharacterString

• Size: 16

• Multiplicity: [1]

namespace

Namespace uniquely identifying the data source of the spatial object.

• Attribute name: namespace (GML), namespace (GeoPackage), Not provided (Vector Tiles)

• Type: CharacterString

• Size: 18

• Multiplicity: [1]

Streets are attributed with an “operationalState” with a data type of “OperationalStateType”. The attribution of this data type is detailed below.

OperationalStateType attributes

state

Indicator identifying the physical nature of the road, for example, Under Construction

• Type: OperationalStateValue

• Size: 19

• Multiplicity: [1]

validTime

If known, the real-world start and end date/times when the state applies.

• Type: TM_Period

• Multiplicity: [0..1]

reason

Short description of the reason for closure.

• Type: CharacterString

• Size: 120

• Multiplicity: [0..1]

Street, Maintenance and SpecialDesignation feature types are made up with the ‘ResponsibleAuthority’ feature type. The below table illustrates what attribution makes up this data type.

ResponsibleAuthority attribute

The authority responsible for the street naming and numbering or maintenance.

identifier

Identification code used to identify the authority

• Attribute name: responsibleAuthority (GML), responsible_authority (GeoPackage), responsible_authority (Vector Tiles)

• Example: 0114

• Multiplicity: [1]

authorityName

Official name of the authority

• Example: Bath and North East Somerset

• Multiplicity: [1]

A PathLink could be attributed with “cycleFacility” with a data type of “CycleFacilityType”. The attribution of this data type is detailed below.

cycleFacility attributes

The cycle amenity available along the link.

• Attribute name: cycleFacility (GML), cycle_facility (GeoPackage), cycle_facility (Vector Tiles)

• Type: CycleFacilityValue

• Multiplicity: [1]

wholeLink

Identifies if the facility applies to entirety of the link.

• Attribute name: cycleFacility_wholeLink (GML), cycle_facility_whole_link (GeoPackage), cycle_facility_whole_link (Vector Tiles)

• Type: Boolean

• Multiplicity: [1]

A PathLink could be attributed with “elevationGain” with a data type of “ElevationGainType”. The attribution of this data type is detailed below.

ElevationGainType attributes

inDirection

Total increase in height experienced when passing along the link from the start to the end.

• Attribute name: elevationGainInDirection(GML), elevationGainInDirection (GeoPackage), Not provided (Vector Tiles)

• Type: Measure

• Multiplicity: [1]

inOppositeDirection

Total increase in height experienced when passing along the link from the end to the start.

• Attribute name: elevationGainInOppositeDirection (GML), elevation_gain_in_opposite_direction (GeoPackage), Not provided (Vector Tiles)

• Type: Measure

• Multiplicity: [1]

The “dateRange” attribute on the ‘TemporalPropertyType’ has a data type of “DateRangeType”. The below table describes how this data type is constructed.

DateRangeType attributes

startDate

The date which the restriction applies starts. This will be in the format YYYY-MM-DD.

• Attribute name: startDate (GML), start_date (GeoPackage), start_date (Vector Tiles)

• Type: Date

• Multiplicity: [0..1]

endDate

The date which the restriction applies ends. This will be in the format YYYY-MM-DD.

• Attribute name: endDate (GML), end_date (GeoPackage), end_date (Vector Tiles)

• Type: Date

• Multiplicity: [0..1]

The “timePeriod” attribute on the ‘DayPropertyType’ has a data type of “TimePropertyType”. The below table describes how this data type is constructed.

• Constraints: A TimePropertyType shall have at least one of timeRange, or namedTime. When namedTime = 'All Day' no other values for namedTime or timeRange shall be populated.

TimePropertyType attributes

namedTime

These are named time periods that do not relate to the same time each day.

• Type: NamedTimeValue

• Multiplicity: [0..*]

timeRange

The range of time which a restriction applies.

• Type: TimeRangeType

• Multiplicity: [0..*]

The “timeRange” attribute on the ‘TimePropertyType’ has a data type of “TimeRangeType”. The below table describes how this data type is constructed.

timeRangeType attributes

startTime

The time the restriction begins

• Attribute name: startTime (GML), start_time (GeoPackage), start_time (Vector Tiles)

• Type: Time

• Multiplicity: [1]

endTime

The time the restriction ends.

• Attribute name: endTime (GML), end_time (GeoPackage), end_time (Vector Tiles)

• Type: Time

• Multiplicity: [1]

The “dayPeriod” attribute on the ‘TemporalPropertyType’ has a data type of “DayPropertyType”. The below table describes how this data type is constructed.

Constraints: A DayPropertyType shall have at least one of namedDay, namedPeriod, or timePeriod. When namedDay = 'All Days' no other values for namedDay or namedPeriod shall be populated.

DayPropertyType attributes

namedDay

The named day this restriction applies to.

• Type: NamedDayValue

• Multiplicity: [0..*]

namedPeriod

The named period this restriction applies to.

• Type: NamedPeriodValue

• Multiplicity: [0..*]

timePeriod

The period of time on the specified day which the restriction applies.

• Type: TimePropertyType

• Multiplicity: [0..*]