{
	"openapi": "3.0.0",
	"components": {
		"examples": {},
		"headers": {},
		"parameters": {},
		"requestBodies": {},
		"responses": {},
		"schemas": {
			"WorkCategoryResponse": {
				"enum": [
					"minor",
					"standard",
					"major",
					"immediate_urgent",
					"immediate_emergency",
					"paa",
					"hs2_highway",
					"upcoming_enum"
				],
				"type": "string"
			},
			"TrafficManagementTypeResponse": {
				"enum": [
					"road_closure",
					"contra_flow",
					"lane_closure",
					"multi_way_signals",
					"two_way_signals",
					"convoy_workings",
					"stop_go_boards",
					"priority_working",
					"give_and_take",
					"some_carriageway_incursion",
					"no_carriageway_incursion",
					"temp_obstruction_15_minute_delay",
					"upcoming_enum"
				],
				"type": "string"
			},
			"GeoJSONCentrePointType": {
				"enum": [
					"Point"
				],
				"type": "string"
			},
			"GeoJSONCentrePoint": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/GeoJSONCentrePointType"
					},
					"coordinates": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"coordinates"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitStatusResponse": {
				"enum": [
					"submitted",
					"granted",
					"permit_modification_request",
					"refused",
					"closed",
					"cancelled",
					"revoked",
					"progressed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"IndustrySectorResponse": {
				"enum": [
					"electric",
					"water",
					"gas",
					"telecoms",
					"transport",
					"highway_authority",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"WorkProperties": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string",
						"description": "Reference number of the work's active permit"
					},
					"promoter_organisation": {
						"type": "string",
						"description": "Name of the promoter organisation"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Street Works Authority code of the promoter, left-padded with zeros to at least 4 characters"
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponse",
						"description": "upcoming_enum is returned if the work category is not yet recognised by this API version"
					},
					"work_category_string": {
						"type": "string"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Actual start date if recorded, otherwise the proposed start date of the current permit version"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Actual end date if recorded, otherwise the proposed end date of the current permit version"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse",
						"description": "Traffic management type from the current permit version\nupcoming_enum is returned if the type is not yet recognised by this API version"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"current_traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse",
						"description": "Only present if a current traffic management type is recorded on the permit\nupcoming_enum is returned if the type is not yet recognised by this API version"
					},
					"current_traffic_management_type_string": {
						"type": "string",
						"description": "Only present if a current traffic management type is recorded on the permit"
					},
					"current_traffic_management_update_date": {
						"type": "string",
						"format": "date-time",
						"description": "Only present if a current traffic management type is recorded on the permit"
					},
					"street": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string",
						"description": "Name of the highway authority for the work"
					},
					"work_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "A GeoJSON Point at the centre of the work location"
					},
					"permit_status": {
						"$ref": "#/components/schemas/PermitStatusResponse",
						"description": "Never cancelled, except for a work added by work_reference_number, which can have any status\nupcoming_enum is returned if the status is not yet recognised by this API version, including under_assessment"
					},
					"permit_status_string": {
						"type": "string"
					},
					"industry_sector": {
						"allOf": [
							{
								"$ref": "#/components/schemas/IndustrySectorResponse"
							}
						],
						"nullable": true,
						"description": "Industry sector of the promoter organisation\nOmitted if the promoter has no industry sector\nupcoming_enum is returned if the sector is not yet recognised by this API version"
					},
					"industry_sector_string": {
						"type": "string",
						"nullable": true,
						"description": "Omitted if the promoter has no industry sector"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"promoter_organisation",
					"promoter_swa_code",
					"work_category",
					"work_category_string",
					"start_date",
					"end_date",
					"traffic_management_type",
					"traffic_management_type_string",
					"street",
					"usrn",
					"town",
					"area",
					"highway_authority",
					"work_centre_point",
					"permit_status",
					"permit_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FeatureType": {
				"enum": [
					"Feature"
				],
				"type": "string"
			},
			"GeoJSONFeatureTypeResponse": {
				"enum": [
					"Point",
					"LineString",
					"Polygon",
					"upcoming_enum"
				],
				"type": "string"
			},
			"GeoJSONGeometry": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/GeoJSONFeatureTypeResponse"
					},
					"type_string": {
						"type": "string"
					},
					"coordinates": {
						"items": {},
						"type": "array"
					}
				},
				"required": [
					"type",
					"type_string",
					"coordinates"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkFeature": {
				"description": "A work whose active permit is not cancelled and whose current permit location intersects the requested bounding box, or the work requested by work_reference_number\nThe geometry is the location from the current version of the work's active permit",
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/WorkProperties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FeatureCollectionType": {
				"enum": [
					"FeatureCollection"
				],
				"type": "string"
			},
			"WorkResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/WorkFeature"
						},
						"type": "array",
						"description": "Contains at most the works result limit (by default 100, configurable) of works from the area search, plus the work requested by work_reference_number if it was not already included; no sort order is guaranteed"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityActivityTypeResponse": {
				"enum": [
					"skips",
					"scaffolding",
					"hoarding",
					"crane_mobile_platform",
					"event",
					"section50",
					"section58",
					"compound",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ActivityProperties": {
				"properties": {
					"activity_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "GeoJSON Point Geometry"
					},
					"activity_name": {
						"type": "string"
					},
					"activity_location_description": {
						"type": "string"
					},
					"activity_reference_number": {
						"type": "string"
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityActivityTypeResponse",
						"description": "upcoming_enum is returned if the activity type is not yet recognised by this API version"
					},
					"activity_type_string": {
						"type": "string"
					},
					"area_name": {
						"type": "string"
					},
					"cancelled": {
						"type": "boolean",
						"description": "Cancelled activities are included in the results; true if the activity has been cancelled"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "The activity end date and time if a time was recorded, otherwise the activity end date"
					},
					"street_name": {
						"type": "string"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "The activity start date and time if a time was recorded, otherwise the activity start date"
					}
				},
				"required": [
					"activity_centre_point",
					"activity_name",
					"activity_location_description",
					"activity_reference_number",
					"activity_type",
					"activity_type_string",
					"area_name",
					"cancelled",
					"end_date",
					"street_name",
					"start_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityFeature": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/ActivityProperties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/ActivityFeature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanStatusResponse": {
				"enum": [
					"raised",
					"cancelled",
					"progressed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ForwardPlanProperties": {
				"properties": {
					"forward_plan_reference_number": {
						"type": "string"
					},
					"work_reference_number": {
						"type": "string"
					},
					"forward_plan_status": {
						"$ref": "#/components/schemas/ForwardPlanStatusResponse"
					},
					"forward_plan_status_string": {
						"type": "string"
					},
					"work_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "GeoJSON Point Geometry"
					},
					"street": {
						"type": "string"
					},
					"area": {
						"type": "string",
						"nullable": true
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"description_of_work": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					}
				},
				"required": [
					"forward_plan_reference_number",
					"work_reference_number",
					"forward_plan_status",
					"forward_plan_status_string",
					"work_centre_point",
					"street",
					"start_date",
					"end_date",
					"description_of_work",
					"promoter_organisation",
					"location_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanFeature": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/ForwardPlanProperties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/ForwardPlanFeature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Hs2ActLimitsFeature": {
				"description": "Contains only the HS2 act limit boundary geometry, simplified to a tolerance of 1 metre; no properties are returned",
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					}
				},
				"required": [
					"type",
					"geometry"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Hs2ActLimitsResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/Hs2ActLimitsFeature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Hs2ActLimitPhase": {
				"enum": [
					"phase_1",
					"phase_2a"
				],
				"type": "string"
			},
			"Section58StatusResponse": {
				"enum": [
					"proposed",
					"in_force",
					"cancelled",
					"closed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section58DurationResponse": {
				"enum": [
					"six_months",
					"one_year",
					"two_years",
					"three_years",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section58ExtentResponse": {
				"enum": [
					"whole_road",
					"part_of_the_road",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LocationTypeResponse": {
				"enum": [
					"footway",
					"carriageway",
					"verge",
					"cycleway",
					"footpath",
					"parking_place",
					"bus_stop_or_stand",
					"cycle_hire_docking_station",
					"taxi_rank",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section58Properties": {
				"properties": {
					"section_58_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "A GeoJSON Point at the centre of the Section 58 location"
					},
					"section_58_reference_number": {
						"type": "string"
					},
					"section_58_status": {
						"$ref": "#/components/schemas/Section58StatusResponse",
						"description": "Always proposed or in_force, except for a Section 58 added by section_58_reference_number, which can have any status\nupcoming_enum is returned if the status is not yet recognised by this API version"
					},
					"section_58_status_string": {
						"type": "string"
					},
					"street_name": {
						"type": "string"
					},
					"area_name": {
						"type": "string",
						"nullable": true
					},
					"organisation_name": {
						"type": "string",
						"description": "Name of the organisation that owns the Section 58"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"restriction_duration": {
						"$ref": "#/components/schemas/Section58DurationResponse",
						"description": "upcoming_enum is returned if the restriction duration is not yet recognised by this API version"
					},
					"restriction_duration_string": {
						"type": "string"
					},
					"restriction_extent": {
						"$ref": "#/components/schemas/Section58ExtentResponse",
						"description": "upcoming_enum is returned if the restriction extent is not yet recognised by this API version"
					},
					"restriction_extent_string": {
						"type": "string"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Empty if no location types are recorded\nupcoming_enum is returned for any location type not yet recognised by this API version"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					}
				},
				"required": [
					"section_58_centre_point",
					"section_58_reference_number",
					"section_58_status",
					"section_58_status_string",
					"street_name",
					"organisation_name",
					"start_date",
					"end_date",
					"restriction_duration",
					"restriction_duration_string",
					"restriction_extent",
					"restriction_extent_string",
					"location_types",
					"location_types_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58Feature": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/Section58Properties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58Response": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/Section58Feature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AncillaryInfoTypeResponse": {
				"enum": [
					"portable_traffic_signals_or_other_traffic_controls",
					"site_welfare_facilities",
					"site_compound_or_material_storage",
					"site_compound_for_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"AncillaryInfoStatusResponse": {
				"enum": [
					"added",
					"removed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"AncillaryInfoProperties": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"ancillary_info_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"ancillary_info_type": {
						"$ref": "#/components/schemas/AncillaryInfoTypeResponse"
					},
					"ancillary_info_status": {
						"$ref": "#/components/schemas/AncillaryInfoStatusResponse"
					},
					"ancillary_info_type_string": {
						"type": "string"
					},
					"ancillary_info_status_string": {
						"type": "string"
					},
					"ancillary_info_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "GeoJSON Point Geometry"
					},
					"ancillary_info_coordinates": {
						"items": {},
						"type": "array"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array"
					}
				},
				"required": [
					"ancillary_info_reference_number",
					"location_description",
					"ancillary_info_type",
					"ancillary_info_status",
					"ancillary_info_type_string",
					"ancillary_info_status_string",
					"ancillary_info_centre_point",
					"ancillary_info_coordinates",
					"promoter_organisation",
					"date_created",
					"usrns"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AncillaryInfoFeature": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/AncillaryInfoProperties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AncillaryInfoResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/AncillaryInfoFeature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationClassificationResponse": {
				"enum": [
					"hazardous",
					"non_hazardous",
					"upcoming_enum"
				],
				"type": "string"
			},
			"MaterialClassificationMaterialTypeResponse": {
				"enum": [
					"coal_tar",
					"total_petroleum_hydrocarbons",
					"ph",
					"heavy_metal",
					"asbestos",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"MaterialClassificationProperties": {
				"properties": {
					"material_classification_reference_number": {
						"type": "string"
					},
					"material_classification_classification": {
						"$ref": "#/components/schemas/MaterialClassificationClassificationResponse",
						"description": "upcoming_enum is returned if the classification is not yet recognised by this API version"
					},
					"material_classification_classification_string": {
						"type": "string"
					},
					"sample_date": {
						"type": "string",
						"format": "date-time"
					},
					"recorded_by_swa_code": {
						"type": "string",
						"description": "SWA code of the organisation that recorded the material classification, left-padded with zeros to 4 characters"
					},
					"recorded_by_organisation_name": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"material_type": {
						"items": {
							"$ref": "#/components/schemas/MaterialClassificationMaterialTypeResponse"
						},
						"type": "array",
						"description": "Only returned when the classification is hazardous; empty if no material types are recorded\nupcoming_enum is returned for any material type not yet recognised by this API version"
					},
					"material_type_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Only returned when the classification is hazardous; empty if no material types are recorded"
					},
					"material_classification_centre_point": {
						"$ref": "#/components/schemas/GeoJSONCentrePoint",
						"description": "GeoJSON geometry of the material classification location; the same value as the feature geometry"
					}
				},
				"required": [
					"material_classification_reference_number",
					"material_classification_classification",
					"material_classification_classification_string",
					"sample_date",
					"recorded_by_swa_code",
					"recorded_by_organisation_name",
					"usrn",
					"material_classification_centre_point"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationFeature": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureType"
					},
					"geometry": {
						"$ref": "#/components/schemas/GeoJSONGeometry",
						"description": "GeoJSON Geometry"
					},
					"properties": {
						"$ref": "#/components/schemas/MaterialClassificationProperties"
					}
				},
				"required": [
					"type",
					"geometry",
					"properties"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationResponse": {
				"properties": {
					"type": {
						"$ref": "#/components/schemas/FeatureCollectionType"
					},
					"features": {
						"items": {
							"$ref": "#/components/schemas/MaterialClassificationFeature"
						},
						"type": "array"
					}
				},
				"required": [
					"type",
					"features"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationClassification": {
				"enum": [
					"hazardous",
					"non_hazardous"
				],
				"type": "string"
			},
			"PotentialClashSummaryResponse": {
				"description": "A work on the requested USRN whose active permit is not cancelled and whose work dates overlap the requested date range\nAlso used for the clashes list returned by the potential collaborations and clashes endpoint",
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string",
						"description": "Reference number of the work's active permit"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Start date of the work"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "End date of the work"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"start_date",
					"end_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PotentialClashesResponse": {
				"description": "Contains at most the potential clashes result limit (by default 25, configurable) of works; any further matches are left out and no sort order is guaranteed",
				"properties": {
					"works": {
						"items": {
							"$ref": "#/components/schemas/PotentialClashSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"works"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PotentialCollaborationsSummaryResponse": {
				"description": "A work whose active permit is not cancelled, whose current permit version says others can collaborate on the work, part of whose location falls within the square extending 500 metres east, west, north and south of the requested point, and whose work dates overlap the requested date range",
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string",
						"description": "Reference number of the work's active permit"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Start date of the work"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "End date of the work"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"start_date",
					"end_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PotentialCollaborationsAndClashesResponse": {
				"properties": {
					"collaborations": {
						"items": {
							"$ref": "#/components/schemas/PotentialCollaborationsSummaryResponse"
						},
						"type": "array",
						"description": "Contains at most the potential collaborations result limit (by default 25, configurable) of works; any further matches are left out and no sort order is guaranteed\nEmpty if no works match"
					},
					"clashes": {
						"items": {
							"$ref": "#/components/schemas/PotentialClashSummaryResponse"
						},
						"type": "array",
						"description": "Only returned when usrn is provided in the request\nContains at most the potential clashes result limit (by default 25, configurable) of works; any further matches are left out and no sort order is guaranteed"
					}
				},
				"required": [
					"collaborations"
				],
				"type": "object",
				"additionalProperties": false
			}
		},
		"securitySchemes": {
			"token": {
				"type": "apiKey",
				"name": "token",
				"in": "header"
			}
		}
	},
	"info": {
		"title": "Street Manager GeoJSON API Stable",
		"version": "1.0.0",
		"description": "See API specification Resource Guide > GeoJSON API for more information on endpoints\nNOTE: Swagger Editor/UI does not display all description text for enumerations and child elements, check swagger.json for full description text",
		"license": {
			"name": "MIT"
		},
		"contact": {}
	},
	"paths": {
		"/works": {
			"get": {
				"operationId": "GetWorksIntersectBoundingBox",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of works whose active permit is not cancelled and whose current permit location\nintersects the bounding box, optionally restricted to works whose permit dates overlap the start_date to end_date\nrange, plus the work matching work_reference_number (if given and found) whatever its permit status, location or\ndates.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401. Results are not restricted to the caller's own organisation.\nBusiness constraints: if more than the works result limit (by default 100, configurable) match the bounding box and\ndate filters, the request is rejected with 403 and the caller must narrow the bounding box or date range; this check\nhappens before, and does not count, the work added by work_reference_number, which is not added again if it is\nalready in the results.\n\nSee API specification Resource Guide > GeoJSON API > Get works endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/activities": {
			"get": {
				"operationId": "GetActivitiesIntersectingBounds",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ActivityResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of all activities, including cancelled ones, whose geometry intersects the\nbounding box, optionally restricted to activities whose dates overlap the start_date to end_date range.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401.\nBusiness constraints: if more than the activities result limit (by default 100, configurable) match, the request is\nrejected with 403 and the caller must narrow the bounding box or date range.\n\nSee API specification Resource Guide > GeoJSON API > Get activities endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					}
				]
			}
		},
		"/forward-plans": {
			"get": {
				"operationId": "GetForwardPlansIntersectBoundingBox",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ForwardPlanResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of raised forward plans whose geometry intersects the bounding box, optionally\nrestricted to those whose dates overlap the start_date to end_date range, plus the forward plan matching\nforward_plan_reference_number (if given and found) whatever its status, location or dates.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401. Results are not restricted to the caller's own organisation.\nBusiness constraints: if more than the forward plans result limit (by default 100, configurable) match the bounding\nbox and date filters, the request is rejected with 403 and the caller must narrow the bounding box or date range;\nthis check happens before, and does not count, the forward plan added by forward_plan_reference_number, which\nappears twice if it also matched the search.\n\nSee API specification Resource Guide > GeoJSON API > Get forward plans endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "forward_plan_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/hs2-act-limits": {
			"get": {
				"operationId": "GetHs2ActLimitsIntersectingBounds",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Hs2ActLimitsResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of the HS2 act limit boundaries for the requested phase whose geometry\nintersects the bounding box, each simplified to a tolerance of 1 metre and returned without properties.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401.\nBusiness constraints: if more than the HS2 act limits result limit (by default 100, configurable) match, the request\nis rejected with 403 and the caller must narrow the bounding box.\n\nSee API specification Resource Guide > GeoJSON API > Get HS2 Act Limits endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "phase",
						"required": true,
						"schema": {
							"$ref": "#/components/schemas/Hs2ActLimitPhase"
						}
					}
				]
			}
		},
		"/section-58s": {
			"get": {
				"operationId": "GetSection58sIntersectBoundingBox",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section58Response"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of all proposed and in-force Section 58s whose geometry intersects the bounding\nbox, optionally restricted to those whose dates overlap the start_date to end_date range, plus the Section 58 matching\nsection_58_reference_number (if given and found) whatever its status, location or dates.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401.\nBusiness constraints: if more than the Section 58s result limit (by default 100, configurable) match the bounding box\nand date filters, the request is rejected with 403 and the caller must narrow the bounding box or date range; this\ncheck happens before, and does not count, the Section 58 added by section_58_reference_number, which appears twice\nif it also matched the search.\n\nSee API specification Resource Guide > GeoJSON API > Get Section 58s endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "section_58_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/ancillary-informations": {
			"get": {
				"operationId": "GetAncillaryInformationIntersectBoundingBox",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/AncillaryInfoResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of added ancillary information with at least one point intersecting the\nbounding box, optionally restricted to those whose works dates overlap the start_date to end_date range, plus the\nancillary information matching ancillary_info_reference_number (if given and found) whatever its status, location\nor dates.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401.\nBusiness constraints: if more than the ancillary informations result limit (by default 100, configurable) match the\nbounding box and date filters, the request is rejected with 403 and the caller must narrow the bounding box or date\nrange; this check happens before, and does not count, the ancillary information added by\nancillary_info_reference_number, which appears twice if it also matched the search.\n\nSee API specification Resource Guide > GeoJSON API > Get AncillaryInformations endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "ancillary_info_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/material-classifications": {
			"get": {
				"operationId": "GetMaterialClassificationsIntersectBoundingBox",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/MaterialClassificationResponse"
								}
							}
						}
					}
				},
				"description": "Returns a GeoJSON feature collection of material classifications, from every organisation, whose location intersects\nthe bounding box and/or that are on the given usrn, optionally restricted by sample date range and classification.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401.\nBusiness constraints: if more than the material classifications result limit (by default 100, configurable) match,\nthe request is rejected with 403 and the caller must narrow the search.\n\nSee API specification Resource Guide > GeoJSON API > Get Material Classifications endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "minEasting",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "minNorthing",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxEasting",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "maxNorthing",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "sample_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "sample_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "classification",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/MaterialClassificationClassification"
						}
					}
				]
			}
		},
		"/potential-clashes": {
			"get": {
				"operationId": "GetPotentialClashes",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PotentialClashesResponse"
								}
							}
						}
					}
				},
				"description": "Returns a summary of the works on the given USRN whose active permit is not cancelled and whose work dates overlap\nthe start_date to end_date range.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401. Results are not restricted to the caller's own organisation.\nBusiness constraints: at most the potential clashes result limit (by default 25, configurable) of works is\nreturned; any further matches are silently left out, no error is returned and no sort order is guaranteed.\n\nSee API specification Resource Guide > GeoJSON API > Get Potential Clashes endpoint for more information",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "usrn",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": true,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": true,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					}
				]
			}
		},
		"/potential-collaborations-and-clashes": {
			"get": {
				"operationId": "GetPotentialCollaborationsAndClashes",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PotentialCollaborationsAndClashesResponse"
								}
							}
						}
					}
				},
				"description": "Returns a summary of the works near the given easting and northing that are open to collaboration and whose work\ndates overlap the start_date to end_date range and, when a usrn is given, a summary of the works on that USRN whose\nwork dates overlap the same range.\n\nAccess: requires a valid token for a user with the Planner, HighwayAuthority or Contractor role who is also an API\nuser; the user's organisation must not be suspended or disabled; a Contractor user's organisation must hold a\ncontract with at least one organisation that is not suspended or disabled. Any authentication or authorisation\nfailure returns 401. Results are not restricted to the caller's own organisation.\nBusiness constraints: collaborations are works whose active permit is not cancelled, whose current permit version\nsays others can collaborate on the work, and whose current permit version location intersects the square extending\n500 metres east, west, north and south of the given point; clashes are only searched for, and the clashes list is\nonly returned, when usrn is given, and include every work on that USRN whose active permit is not cancelled; at most\nthe potential collaborations result limit (by default 25, configurable) of collaborations and at most the potential\nclashes result limit (by default 25, configurable) of clashes are returned; any further matches are silently left\nout, no error is returned and no sort order is guaranteed.\n\nSee API specification Resource Guide > GeoJSON API > Get Potential Collaborations and Clashes endpoint for more\ninformation",
				"security": [
					{
						"token": [
							"Planner",
							"HighwayAuthority",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "easting",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "northing",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"in": "query",
						"name": "start_date",
						"required": true,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "end_date",
						"required": true,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					}
				]
			}
		}
	},
	"servers": [
		{
			"url": "/"
		}
	]
}