{
	"openapi": "3.0.0",
	"components": {
		"examples": {},
		"headers": {},
		"parameters": {},
		"requestBodies": {},
		"responses": {},
		"schemas": {
			"PermitConditionTypeResponse": {
				"enum": [
					"NCT01a",
					"NCT01b",
					"NCT02a",
					"NCT02b",
					"NCT04a",
					"NCT04b",
					"NCT05a",
					"NCT06a",
					"NCT07a",
					"NCT08a",
					"NCT08b",
					"NCT09a",
					"NCT09b",
					"NCT09c",
					"NCT10a",
					"NCT11a",
					"NCT11b",
					"NCT12a",
					"NCT09d",
					"NCT03",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitConditionResponse": {
				"properties": {
					"condition": {
						"$ref": "#/components/schemas/PermitConditionTypeResponse"
					},
					"condition_string": {
						"type": "string"
					},
					"comment": {
						"type": "string",
						"nullable": true,
						"description": "Max length 1500 characters"
					}
				},
				"required": [
					"condition",
					"condition_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReasonForRefusalResponse": {
				"enum": [
					"RC10",
					"RC11",
					"RC12",
					"RC20",
					"RC21",
					"RC22",
					"RC23",
					"RC30",
					"RC31",
					"RC32",
					"RC33",
					"RC40",
					"RC41",
					"RC42",
					"RC43",
					"RC44",
					"RC50",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ActivityTypeResponse": {
				"enum": [
					"highway_improvement_works",
					"highway_repair_and_maintenance_works",
					"utility_asset_works",
					"utility_repair_and_maintenance_works",
					"diversionary_works",
					"disconnection_or_alteration_of_supply",
					"permanent_reinstatement",
					"remedial_works",
					"section_58",
					"section_50",
					"core_sampling",
					"statutory_infrastructure_works",
					"works_for_rail_purposes",
					"works_for_road_purposes",
					"new_service_connection",
					"optional_permit_no_fee",
					"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"
			},
			"ApplicationTypeResponse": {
				"enum": [
					"permit",
					"notice",
					"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"
			},
			"AssessmentStatusResponse": {
				"enum": [
					"granted",
					"granted_auto",
					"refused",
					"refused_auto",
					"permit_modification_request",
					"revoked",
					"upcoming_enum"
				],
				"type": "string"
			},
			"FileSummaryResponse": {
				"properties": {
					"file_id": {
						"type": "number",
						"format": "double",
						"description": "Required\nIdentifier of the file."
					},
					"name": {
						"type": "string",
						"description": "Required\nName of the file."
					}
				},
				"required": [
					"file_id",
					"name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ASDCodeResponse": {
				"enum": [
					1,
					2,
					3,
					6,
					8,
					9,
					10,
					12,
					13,
					16,
					17,
					18,
					19,
					20,
					21,
					22,
					23,
					24,
					25,
					26,
					27,
					28,
					29,
					30,
					999
				],
				"type": "number"
			},
			"ASDPeriodicityCodeResponse": {
				"enum": [
					1,
					2,
					3,
					7,
					8,
					9,
					10,
					11,
					12,
					13,
					14,
					15,
					16,
					999
				],
				"type": "number"
			},
			"PermitASDResponse": {
				"properties": {
					"special_desig_location_text": {
						"type": "string",
						"nullable": true,
						"description": "Max length 255 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 300 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"asd_coordinate_geometry": {
						"nullable": true,
						"description": "Is a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and is either a point, line string or polygon"
					},
					"street_special_desig_code": {
						"$ref": "#/components/schemas/ASDCodeResponse"
					},
					"street_special_desig_code_string": {
						"type": "string"
					},
					"special_desig_periodicity_code": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ASDPeriodicityCodeResponse"
							}
						],
						"nullable": true
					},
					"special_desig_periodicity_code_string": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"street_special_desig_code",
					"street_special_desig_code_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AlterationStatusResponse": {
				"enum": [
					"submitted",
					"granted",
					"granted_with_duration_challenge",
					"refused",
					"deemed",
					"cancelled",
					"revoked",
					"auto_applied",
					"upcoming_enum"
				],
				"type": "string"
			},
			"AlterationTypeResponse": {
				"enum": [
					"PROMOTER_IMPOSED_CHANGE",
					"PROMOTER_CHANGE_REQUEST",
					"HA_CHANGE_REQUEST",
					"HA_IMPOSED_CHANGE",
					"WORK_EXTENSION",
					"DURATION_CHALLENGE",
					"MODIFIED_PERMIT",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitAlterationSummaryResponse": {
				"properties": {
					"permit_alteration_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"alteration_status": {
						"$ref": "#/components/schemas/AlterationStatusResponse"
					},
					"alteration_status_string": {
						"type": "string"
					},
					"alteration_type": {
						"$ref": "#/components/schemas/AlterationTypeResponse"
					},
					"alteration_type_string": {
						"type": "string"
					}
				},
				"required": [
					"permit_alteration_reference_number",
					"date_created",
					"deadline_date",
					"alteration_status",
					"alteration_status_string",
					"alteration_type",
					"alteration_type_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestStatusResponse": {
				"enum": [
					"submitted",
					"granted",
					"refused",
					"deemed",
					"cancelled",
					"granted_with_duration_challenge",
					"revoked",
					"auto_applied",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ChangeRequestTypeResponse": {
				"enum": [
					"PROMOTER_IMPOSED_CHANGE",
					"PROMOTER_CHANGE_REQUEST",
					"HA_CHANGE_REQUEST",
					"HA_IMPOSED_CHANGE",
					"WORK_EXTENSION",
					"DURATION_CHALLENGE",
					"MODIFIED_PERMIT",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ChangeRequestSummaryResponse": {
				"properties": {
					"change_request_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"change_request_status": {
						"$ref": "#/components/schemas/ChangeRequestStatusResponse"
					},
					"change_request_status_string": {
						"type": "string"
					},
					"change_request_type": {
						"$ref": "#/components/schemas/ChangeRequestTypeResponse"
					},
					"change_request_type_string": {
						"type": "string"
					}
				},
				"required": [
					"change_request_reference_number",
					"date_created",
					"deadline_date",
					"change_request_status",
					"change_request_status_string",
					"change_request_type",
					"change_request_type_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkTypeResponse": {
				"enum": [
					"planned",
					"immediate",
					"hs2_highway_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CloseFootwayResponse": {
				"enum": [
					"yes_provide_pedestrian_walkway",
					"yes_provide_alternative_route",
					"no",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LaneRentalAssessmentOutcomeResponse": {
				"enum": [
					"chargeable",
					"potentially_chargeable",
					"charges_waived",
					"exempt",
					"charges_not_applicable",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LaneRentalAssessmentChargeBandResponse": {
				"enum": [
					"charge_band_1",
					"charge_band_2",
					"charge_band_3",
					"charge_band_4",
					"charge_band_5",
					"upcoming_enum"
				],
				"type": "string"
			},
			"WorkStatusResponse": {
				"enum": [
					"planned",
					"in_progress",
					"completed",
					"cancelled",
					"unattributable",
					"historical",
					"non_notifiable",
					"section_81",
					"upcoming_enum"
				],
				"type": "string"
			},
			"HS2HighwayExemptionResponse": {
				"enum": [
					"works_to_a_bridge",
					"alteration_or_disturbance_to_apparatus",
					"depositing_soil_or_materials",
					"erection_of_scaffolding",
					"none_applicable",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LinkedSection81": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"section_81_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"section_81_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DurationChallengeReviewStatusResponse": {
				"enum": [
					"duration_challenge_accepted",
					"duration_challenge_not_accepted",
					"upcoming_enum"
				],
				"type": "string"
			},
			"DurationChallengeNonAcceptanceResponseStatusResponse": {
				"enum": [
					"reasonable_period_end_date_changed",
					"reasonable_period_end_date_not_changed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CloseFootpathResponse": {
				"enum": [
					"yes_discussed_with_ha",
					"no",
					"upcoming_enum"
				],
				"type": "string"
			},
			"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"
			},
			"AncillaryInfoSummaryResponse": {
				"properties": {
					"ancillary_info_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string",
						"nullable": true
					},
					"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"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"date_removed": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"ancillary_info_description": {
						"type": "string"
					},
					"ancillary_info_removal_reason": {
						"type": "string",
						"nullable": true
					},
					"ancillary_info_coordinates": {
						"items": {},
						"type": "array"
					},
					"usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array"
					}
				},
				"required": [
					"ancillary_info_reference_number",
					"ancillary_info_type",
					"ancillary_info_status",
					"ancillary_info_type_string",
					"ancillary_info_status_string",
					"date_created",
					"ancillary_info_description",
					"ancillary_info_coordinates",
					"usrns"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitCancellationReasonResponse": {
				"enum": [
					"admin_error",
					"customer_reasons",
					"requested_by_highway_authority",
					"private_works",
					"clash_of_works_on_site",
					"traffic_management_issues",
					"parking_issues",
					"no_staff_or_resource",
					"higher_priority_works",
					"weather",
					"further_action_required",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InterestedParty": {
				"properties": {
					"name": {
						"type": "string"
					},
					"swa_code": {
						"type": "string"
					}
				},
				"required": [
					"name",
					"swa_code"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonComplianceStatusResponse": {
				"enum": [
					"issued",
					"withdrawn",
					"resolved",
					"upcoming_enum"
				],
				"type": "string"
			},
			"NonComplianceSummaryResponse": {
				"properties": {
					"non_compliance_reference_number": {
						"type": "string"
					},
					"non_compliance_date": {
						"type": "string",
						"format": "date-time"
					},
					"non_compliance_status": {
						"$ref": "#/components/schemas/NonComplianceStatusResponse"
					},
					"non_compliance_status_string": {
						"type": "string"
					}
				},
				"required": [
					"non_compliance_reference_number",
					"non_compliance_date",
					"non_compliance_status",
					"non_compliance_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CollaborationTypeResponse": {
				"enum": [
					"trench_sharing_primary_promoter",
					"trench_sharing_secondary_promoter",
					"sharing_traffic_management_only",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitCollaborationInfo": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"promoter_organisation_name": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"date_created",
					"promoter_organisation_name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitStatusResponse": {
				"enum": [
					"submitted",
					"granted",
					"permit_modification_request",
					"refused",
					"closed",
					"cancelled",
					"revoked",
					"progressed",
					"under_assessment",
					"upcoming_enum"
				],
				"type": "string"
			},
			"WorkCategoryResponseEnum": {
				"enum": [
					"minor",
					"standard",
					"major",
					"immediate_urgent",
					"immediate_emergency",
					"paa",
					"hs2_highway",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the permit."
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed start date from the current version of the permit."
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed end date from the current version of the permit."
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe actual start date recorded against the permit. Not set until work has started."
					},
					"actual_stop_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe actual stop date recorded against the permit. Not set until work has stopped."
					},
					"permit_status": {
						"$ref": "#/components/schemas/PermitStatusResponse",
						"description": "Required\nThe current status of the permit."
					},
					"permit_status_string": {
						"type": "string",
						"description": "Required\nThe current status of the permit, as text."
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponseEnum",
						"description": "Required\nThe work category from the current version of the permit."
					},
					"work_category_string": {
						"type": "string",
						"description": "Required\nThe work category from the current version of the permit, as text."
					},
					"work_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_contact_details": {
						"type": "string"
					},
					"secondary_contact": {
						"type": "string"
					},
					"secondary_contact_number": {
						"type": "string"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"calendar_day_duration": {
						"type": "number",
						"format": "double"
					},
					"working_day_duration": {
						"type": "number",
						"format": "double"
					},
					"description_of_work": {
						"type": "string"
					},
					"excavation": {
						"type": "boolean"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true
					},
					"traffic_management_plan": {
						"type": "boolean"
					},
					"lane_rental_applicable": {
						"type": "boolean"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitConditionResponse"
						},
						"type": "array",
						"nullable": true
					},
					"street_name": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area_name": {
						"type": "string",
						"nullable": true
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"highway_authority": {
						"type": "string"
					},
					"highway_authority_swa_code": {
						"type": "string"
					},
					"road_category": {
						"type": "number",
						"format": "double"
					},
					"road_category_is_active": {
						"type": "boolean"
					},
					"works_location_description": {
						"type": "string"
					},
					"works_coordinates": {},
					"collaborative_working": {
						"type": "boolean"
					},
					"collaboration_details": {
						"type": "string",
						"nullable": true
					},
					"collaborative_works": {
						"type": "string",
						"nullable": true
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"date_modified": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"assessment_comments": {
						"type": "string",
						"nullable": true
					},
					"reasons_for_refusal": {
						"items": {
							"$ref": "#/components/schemas/ReasonForRefusalResponse"
						},
						"type": "array",
						"nullable": true
					},
					"reasons_for_refusal_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityTypeResponse"
					},
					"activity_type_string": {
						"type": "string"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"application_type": {
						"$ref": "#/components/schemas/ApplicationTypeResponse"
					},
					"application_type_string": {
						"type": "string"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					},
					"assessment_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/AssessmentStatusResponse"
							}
						],
						"nullable": true
					},
					"assessment_status_string": {
						"type": "string",
						"nullable": true
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true
					},
					"permit_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASDResponse"
						},
						"type": "array"
					},
					"permit_not_selected_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASDResponse"
						},
						"type": "array"
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"nullable": true
					},
					"assessment_discount_reason": {
						"type": "string",
						"nullable": true
					},
					"is_ttro_required": {
						"type": "boolean",
						"nullable": true
					},
					"immediate_risk": {
						"type": "boolean",
						"nullable": true
					},
					"is_early_start": {
						"type": "boolean"
					},
					"is_deemed": {
						"type": "boolean"
					},
					"early_start_pre_approval": {
						"type": "boolean",
						"nullable": true
					},
					"pre_approval_details": {
						"type": "string",
						"nullable": true
					},
					"pre_approval_authoriser": {
						"type": "string",
						"nullable": true
					},
					"early_start_reason": {
						"type": "string",
						"nullable": true
					},
					"additional_info": {
						"type": "string",
						"nullable": true
					},
					"permit_alterations": {
						"items": {
							"$ref": "#/components/schemas/PermitAlterationSummaryResponse"
						},
						"type": "array",
						"nullable": true
					},
					"change_requests": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestSummaryResponse"
						},
						"type": "array",
						"nullable": true
					},
					"work_type": {
						"$ref": "#/components/schemas/WorkTypeResponse"
					},
					"work_type_string": {
						"type": "string"
					},
					"revoke_reason": {
						"type": "string",
						"nullable": true
					},
					"sliding_end_date_candidate": {
						"type": "boolean"
					},
					"validity_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"final_reinstatement": {
						"type": "boolean"
					},
					"workstream_prefix": {
						"type": "string"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootwayResponse"
					},
					"close_footway_string": {
						"type": "string"
					},
					"lane_rental_assessment_outcome": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LaneRentalAssessmentOutcomeResponse"
							}
						],
						"nullable": true
					},
					"lane_rental_assessment_outcome_string": {
						"type": "string",
						"nullable": true
					},
					"lane_rental_assessment_additional_details": {
						"type": "string",
						"nullable": true
					},
					"lane_rental_assessment_charge_band": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LaneRentalAssessmentChargeBandResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe lane rental charge band recorded on the assessment."
					},
					"lane_rental_assessment_charge_band_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe lane rental charge band recorded on the assessment, as a string."
					},
					"lane_rental_assessment_chargeable_days": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nThe number of chargeable days recorded on the assessment."
					},
					"lane_rental_assessment_charges_agreed": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether the lane rental charges have been agreed with the promoter."
					},
					"is_lane_rental": {
						"type": "boolean"
					},
					"pending_change_details": {
						"type": "string",
						"nullable": true
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					},
					"hs2_in_act_limits": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"hs2_highway_exemption": {
						"allOf": [
							{
								"$ref": "#/components/schemas/HS2HighwayExemptionResponse"
							}
						],
						"nullable": true
					},
					"hs2_highway_exemption_string": {
						"type": "string",
						"nullable": true
					},
					"hs2_is_consultation": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_is_consent": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_highway_emails": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true
					},
					"hs2_acknowledged": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_acknowledged_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"additional_contact": {
						"type": "string",
						"nullable": true
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true
					},
					"ever_modification_requested": {
						"type": "boolean"
					},
					"is_duration_challenged": {
						"type": "boolean",
						"nullable": true
					},
					"is_covid_19_response": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_additional_usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true
					},
					"excavation_carried_out": {
						"type": "boolean"
					},
					"linked_section_81": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LinkedSection81"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status_string": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_reason_for_non_acceptance": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_review_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_details": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_new_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_old_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true
					},
					"current_traffic_management_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/TrafficManagementTypeResponse"
							}
						],
						"nullable": true
					},
					"current_traffic_management_type_string": {
						"type": "string",
						"nullable": true
					},
					"current_traffic_management_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"current_traffic_management_emergency_contact_name": {
						"type": "string",
						"nullable": true
					},
					"current_traffic_management_emergency_contact_number": {
						"type": "string",
						"nullable": true
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpathResponse"
					},
					"close_footpath_string": {
						"type": "string"
					},
					"ancillary_informations": {
						"items": {
							"$ref": "#/components/schemas/AncillaryInfoSummaryResponse"
						},
						"type": "array",
						"nullable": true
					},
					"street_line": {},
					"reinstatement_registration_due_date": {
						"type": "string",
						"format": "date-time"
					},
					"usrn_contains_hazardous_material": {
						"type": "boolean",
						"nullable": true
					},
					"permit_cancellation_reason": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PermitCancellationReasonResponse"
							}
						],
						"nullable": true
					},
					"permit_cancellation_reason_string": {
						"type": "string",
						"nullable": true
					},
					"permit_cancellation_reason_other": {
						"type": "string",
						"nullable": true
					},
					"interested_parties": {
						"items": {
							"$ref": "#/components/schemas/InterestedParty"
						},
						"type": "array",
						"nullable": true
					},
					"linked_non_compliance": {
						"allOf": [
							{
								"$ref": "#/components/schemas/NonComplianceSummaryResponse"
							}
						],
						"nullable": true
					},
					"is_primary_promoter": {
						"type": "boolean",
						"nullable": true
					},
					"collaboration_types": {
						"items": {
							"$ref": "#/components/schemas/CollaborationTypeResponse"
						},
						"type": "array",
						"nullable": true
					},
					"collaboration_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true
					},
					"primary_promoter_permit_reference_number": {
						"type": "string",
						"nullable": true
					},
					"collaboration_contact_name": {
						"type": "string",
						"nullable": true
					},
					"collaboration_contact_email": {
						"type": "string",
						"nullable": true
					},
					"collaboration_contact_phone_number": {
						"type": "string",
						"nullable": true
					},
					"estimated_number_of_network_days_saved": {
						"type": "number",
						"format": "double",
						"nullable": true
					},
					"others_can_collaborate_on_work": {
						"type": "boolean",
						"nullable": true
					},
					"reason_for_non_collaboration": {
						"type": "string",
						"nullable": true
					},
					"can_collaborate_on_work_additional_details": {
						"type": "string",
						"nullable": true
					},
					"primary_promoter_work_reference_number": {
						"type": "string",
						"nullable": true
					},
					"potential_clash_with_other_works": {
						"type": "boolean",
						"nullable": true
					},
					"collaborating_permits": {
						"items": {
							"$ref": "#/components/schemas/PermitCollaborationInfo"
						},
						"type": "array",
						"nullable": true
					}
				},
				"required": [
					"permit_reference_number",
					"proposed_start_date",
					"proposed_end_date",
					"permit_status",
					"permit_status_string",
					"work_category",
					"work_category_string",
					"work_reference_number",
					"promoter_organisation",
					"promoter_swa_code",
					"promoter_contact_details",
					"secondary_contact",
					"secondary_contact_number",
					"reasonable_period_end_date",
					"calendar_day_duration",
					"working_day_duration",
					"description_of_work",
					"excavation",
					"traffic_management_plan",
					"lane_rental_applicable",
					"street_name",
					"usrn",
					"highway_authority",
					"highway_authority_swa_code",
					"road_category",
					"works_location_description",
					"works_coordinates",
					"collaborative_working",
					"date_created",
					"date_modified",
					"deadline_date",
					"activity_type",
					"activity_type_string",
					"traffic_management_type",
					"traffic_management_type_string",
					"application_type",
					"application_type_string",
					"location_types",
					"location_types_string",
					"permit_asds",
					"permit_not_selected_asds",
					"is_early_start",
					"is_deemed",
					"work_type",
					"work_type_string",
					"sliding_end_date_candidate",
					"validity_period_end_date",
					"final_reinstatement",
					"workstream_prefix",
					"close_footway",
					"close_footway_string",
					"is_lane_rental",
					"work_status",
					"work_status_string",
					"ever_modification_requested",
					"excavation_carried_out",
					"close_footpath",
					"close_footpath_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitCreateResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"permit_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HS2HighwayExemption": {
				"enum": [
					"works_to_a_bridge",
					"alteration_or_disturbance_to_apparatus",
					"depositing_soil_or_materials",
					"erection_of_scaffolding",
					"none_applicable"
				],
				"type": "string"
			},
			"PermitConditionType": {
				"enum": [
					"NCT01a",
					"NCT01b",
					"NCT02a",
					"NCT02b",
					"NCT04a",
					"NCT04b",
					"NCT05a",
					"NCT06a",
					"NCT07a",
					"NCT08a",
					"NCT08b",
					"NCT09a",
					"NCT09b",
					"NCT09c",
					"NCT10a",
					"NCT11a",
					"NCT11b",
					"NCT12a",
					"NCT09d",
					"NCT03"
				],
				"type": "string"
			},
			"PermitCondition": {
				"properties": {
					"condition": {
						"$ref": "#/components/schemas/PermitConditionType"
					},
					"comment": {
						"type": "string",
						"nullable": true,
						"description": "Max length 1500 characters"
					}
				},
				"required": [
					"condition"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityType": {
				"enum": [
					"highway_improvement_works",
					"highway_repair_and_maintenance_works",
					"utility_asset_works",
					"utility_repair_and_maintenance_works",
					"diversionary_works",
					"disconnection_or_alteration_of_supply",
					"permanent_reinstatement",
					"remedial_works",
					"section_58",
					"section_50",
					"core_sampling",
					"statutory_infrastructure_works",
					"works_for_rail_purposes",
					"works_for_road_purposes",
					"new_service_connection",
					"optional_permit_no_fee"
				],
				"type": "string"
			},
			"TrafficManagementType": {
				"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"
				],
				"type": "string"
			},
			"ApplicationType": {
				"enum": [
					"permit",
					"notice"
				],
				"type": "string"
			},
			"CollaborationType": {
				"enum": [
					"trench_sharing_primary_promoter",
					"trench_sharing_secondary_promoter",
					"sharing_traffic_management_only",
					"other"
				],
				"type": "string"
			},
			"LocationType": {
				"enum": [
					"footway",
					"carriageway",
					"verge",
					"cycleway",
					"footpath",
					"parking_place",
					"bus_stop_or_stand",
					"cycle_hire_docking_station",
					"taxi_rank"
				],
				"type": "string"
			},
			"WorkType": {
				"enum": [
					"planned",
					"immediate",
					"hs2_highway_works"
				],
				"type": "string"
			},
			"CloseFootway": {
				"enum": [
					"yes_provide_pedestrian_walkway",
					"yes_provide_alternative_route",
					"no"
				],
				"type": "string"
			},
			"CloseFootpath": {
				"enum": [
					"yes_discussed_with_ha",
					"no"
				],
				"type": "string"
			},
			"ASDCode": {
				"enum": [
					1,
					2,
					3,
					6,
					8,
					9,
					10,
					12,
					13,
					16,
					17,
					18,
					19,
					20,
					21,
					22,
					23,
					24,
					25,
					26,
					27,
					28,
					29,
					30
				],
				"type": "number"
			},
			"ASDPeriodicityCode": {
				"enum": [
					1,
					2,
					3,
					7,
					8,
					9,
					10,
					11,
					12,
					13,
					14,
					15,
					16
				],
				"type": "number"
			},
			"PermitASD": {
				"properties": {
					"special_desig_location_text": {
						"type": "string",
						"nullable": true,
						"description": "Max length 255 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 300 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"asd_coordinate_geometry": {
						"nullable": true,
						"description": "Is a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and is either a point, line string or polygon"
					},
					"street_special_desig_code": {
						"$ref": "#/components/schemas/ASDCode",
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_periodicity_code": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ASDPeriodicityCode"
							}
						],
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					}
				},
				"required": [
					"street_special_desig_code"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"secondary_contact": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_number": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be a valid date"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if proposed_start_date is in the past, or if work_type is immediate. Otherwise optional\nMust be on the same date as proposed_start_date"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be on or after proposed_start_date\nThe maximum duration between proposed_start_date and proposed_end_date is 5 years, for all work types"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if proposed_end_date is in the past. Otherwise optional\nMust be on the same date as proposed_end_date\nIf proposed_end_date is the same as proposed_start_date, must be after proposed_start_time"
					},
					"description_of_work": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"excavation": {
						"type": "boolean",
						"description": "Required\nWhether an excavation will be required"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"traffic_management_plan": {
						"type": "boolean",
						"description": "Required"
					},
					"lane_rental_applicable": {
						"type": "boolean",
						"description": "Required"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitCondition"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray values must be unique (each condition can only appear once)\nEach comment has a max length of 1500 characters"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"works_coordinates": {
						"nullable": true,
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nA point must have exactly 2 values (easting and northing)"
					},
					"collaborative_working": {
						"type": "boolean",
						"description": "Required"
					},
					"collaboration_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is true. Otherwise optional\nMax length 500 characters"
					},
					"collaborative_works": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly saved if collaborative_working is true\nMax length 500 characters\nWork reference number of the collaborative works"
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityType",
						"description": "Required"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType",
						"description": "Required"
					},
					"application_type": {
						"$ref": "#/components/schemas/ApplicationType",
						"description": "Required"
					},
					"collaboration_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/CollaborationType"
							}
						],
						"nullable": true,
						"description": "Required if collaborative_working is true and collaboration_types is not supplied. Otherwise optional"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nOnly an HS2 promoter may use bus_stop_or_stand, cycle_hire_docking_station, parking_place or taxi_rank"
					},
					"early_start_pre_approval": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if the permit is calculated to be an early start. Otherwise optional\nSee business rules section 2.1.4.6 - Early start"
					},
					"pre_approval_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is true\nMax length 500 characters"
					},
					"pre_approval_authoriser": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is true\nMax length 100 characters"
					},
					"early_start_reason": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is false\nMax length 500 characters"
					},
					"work_type": {
						"$ref": "#/components/schemas/WorkType",
						"description": "Required\nhs2_highway_works can only be used by the HS2 promoter"
					},
					"is_ttro_required": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if work_type is planned\nMust not be supplied for any other work type"
					},
					"immediate_risk": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if work_type is immediate\nMust not be supplied for any other work type"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nMax 50 values\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootway",
						"description": "Required"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpath",
						"description": "Required"
					},
					"permit_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASD"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional"
					},
					"additional_contact": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nOnly checked if you are the HS2 promoter and work_type is hs2_highway_works\nDate must be today or a date in the future"
					},
					"hs2_highway_emails": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nOnly checked if you are the HS2 promoter and work_type is hs2_highway_works\nArray max length 2 items\nArray values must be valid email addresses\nArray values max length 100 characters"
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if traffic_management_type is multi_way_signals or two_way_signals. Otherwise optional\nMax length 100 characters"
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Required if traffic_management_type is multi_way_signals or two_way_signals. Otherwise optional\nMax length 100 characters"
					},
					"is_primary_promoter": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if collaborative_working is true. Otherwise optional"
					},
					"collaboration_types": {
						"items": {
							"$ref": "#/components/schemas/CollaborationType"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if collaborative_working is true or others_can_collaborate_on_work is true (this may be supplied as collaboration_type instead when collaborative_working is true)\nArray values must be unique\nCannot contain both trench_sharing_primary_promoter and trench_sharing_secondary_promoter\nIf is_primary_promoter is true, cannot contain trench_sharing_secondary_promoter\nIf is_primary_promoter is false, cannot contain trench_sharing_primary_promoter"
					},
					"primary_promoter_permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nOnly used if collaborative_working is true and is_primary_promoter is false, to link to the primary promoter's permit"
					},
					"collaboration_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is true or others_can_collaborate_on_work is true. Otherwise optional\nMax length 100 characters"
					},
					"collaboration_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional, but at least one of collaboration_contact_email or collaboration_contact_phone_number is required if collaborative_working is true or others_can_collaborate_on_work is true\nMax length 100 characters"
					},
					"collaboration_contact_phone_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, but at least one of collaboration_contact_email or collaboration_contact_phone_number is required if collaborative_working is true or others_can_collaborate_on_work is true\nMax length 100 characters"
					},
					"estimated_number_of_network_days_saved": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Required if collaborative_working is true and is_primary_promoter is false. Otherwise optional\nMust be a whole number, 0 or greater"
					},
					"others_can_collaborate_on_work": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if collaborative_working is false. Otherwise optional"
					},
					"reason_for_non_collaboration": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is false and others_can_collaborate_on_work is false. Otherwise optional\nMax length 500 characters"
					},
					"can_collaborate_on_work_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is false and others_can_collaborate_on_work is true. Otherwise optional\nMax length 500 characters"
					},
					"workstream_prefix": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly checked for historic or non-notifiable works\nMust be exactly 3 characters, consisting of digits only, and must not be '000'\nMust exist in your organisation, unless the works already has a permit, in which case it must match the works' existing workstream"
					},
					"hs2_in_act_limits": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if you are the HS2 promoter"
					},
					"hs2_highway_exemption": {
						"allOf": [
							{
								"$ref": "#/components/schemas/HS2HighwayExemption"
							}
						],
						"nullable": true,
						"description": "Required if you are the HS2 promoter, work_type is hs2_highway_works and hs2_in_act_limits is true"
					},
					"hs2_additional_usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nOnly checked if you are the HS2 promoter and work_type is hs2_highway_works\nArray max length 10 items\nArray values must be unique\nArray values must be whole numbers between 100001 and 99999999"
					},
					"non_compliance_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 106 characters\nCreated permit will be linked to an existing non-compliance with this reference number\nNon-compliance must have a status of issued and must be associated with the same works"
					}
				},
				"required": [
					"secondary_contact",
					"secondary_contact_number",
					"proposed_start_date",
					"proposed_end_date",
					"description_of_work",
					"excavation",
					"traffic_management_plan",
					"lane_rental_applicable",
					"works_location_description",
					"collaborative_working",
					"activity_type",
					"traffic_management_type",
					"application_type",
					"location_types",
					"work_type",
					"close_footway",
					"close_footpath"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitStatus": {
				"enum": [
					"submitted",
					"granted",
					"permit_modification_request",
					"refused",
					"closed",
					"cancelled",
					"revoked",
					"progressed",
					"under_assessment"
				],
				"type": "string"
			},
			"PermitCancellationReason": {
				"enum": [
					"admin_error",
					"customer_reasons",
					"requested_by_highway_authority",
					"private_works",
					"clash_of_works_on_site",
					"traffic_management_issues",
					"parking_issues",
					"no_staff_or_resource",
					"higher_priority_works",
					"weather",
					"further_action_required",
					"other"
				],
				"type": "string"
			},
			"PermitStatusUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"permit_status": {
						"$ref": "#/components/schemas/PermitStatus",
						"description": "Required\nMust be cancelled, the only status that can be set\nSee business rules section 2.1.4.9 - Cancelling PAA & PA"
					},
					"additional_comments": {
						"type": "string",
						"nullable": true,
						"description": "Required\nMax length 500 characters\nRecorded as the cancellation details"
					},
					"permit_cancellation_reason": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PermitCancellationReason"
							}
						],
						"nullable": true,
						"description": "Optional\nRecorded against the permit. For a PAA the reason is not included in the audit entry."
					},
					"permit_cancellation_reason_other": {
						"type": "string",
						"nullable": true,
						"description": "Required if permit_cancellation_reason is other\nMax length 100 characters\nIgnored for any other cancellation reason"
					}
				},
				"required": [
					"permit_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AssessmentStatus": {
				"enum": [
					"granted",
					"granted_auto",
					"refused",
					"refused_auto",
					"permit_modification_request",
					"revoked"
				],
				"type": "string"
			},
			"ReasonForRefusal": {
				"enum": [
					"RC10",
					"RC11",
					"RC12",
					"RC20",
					"RC21",
					"RC22",
					"RC23",
					"RC30",
					"RC31",
					"RC32",
					"RC33",
					"RC40",
					"RC41",
					"RC42",
					"RC43",
					"RC44",
					"RC50"
				],
				"type": "string"
			},
			"PermitAssessmentUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"assessment_status": {
						"$ref": "#/components/schemas/AssessmentStatus",
						"description": "Required\nMust be one of granted, refused, revoked or permit_modification_request (granted_auto and refused_auto are set by Street Manager and are rejected)\nSee business rules section 5 - Revoking a PA"
					},
					"additional_comments": {
						"type": "string",
						"nullable": true,
						"description": "Required if assessment_status = refused or is_duration_challenged = true, otherwise Optional\nMax length 1500 characters\nAlso validated when assessment_status = granted, the permit is a PAA or HS2 highway permit and a value is provided"
					},
					"reasons_for_refusal": {
						"items": {
							"$ref": "#/components/schemas/ReasonForRefusal"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if assessment_status = refused, otherwise Optional\nArray values must be unique\nMust contain between 1 and 5 values"
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nOnly used when assessment_status = granted and permit's work_category != hs2_highway\nIs whole number between 0 and 100 inclusive; validated only when a non-zero value is provided\nDefaults to 0 when omitted"
					},
					"revoke_reason": {
						"type": "string",
						"nullable": true,
						"description": "Required if assessment_status = revoked, otherwise Optional\nMax length 500 characters"
					},
					"pending_change_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if assessment_status = permit_modification_request, otherwise Optional\nMax length 500 characters"
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if is_duration_challenged = true, otherwise Optional\nWhen assessment_status = granted, must be at least 2 working days from the permit start date and no later than the permit end date"
					},
					"is_duration_challenged": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nOnly has an effect when assessment_status = granted and the permit is an immediate permit"
					}
				},
				"required": [
					"assessment_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitDiscountUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"description": "Required\nWhole number from 0 to 100 inclusive. Percentage discount applied to the permit's standard fee"
					},
					"assessment_discount_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters. Reason for the discount"
					}
				},
				"required": [
					"assessment_discount"
				],
				"type": "object",
				"additionalProperties": false
			},
			"LaneRentalAssessmentOutcome": {
				"enum": [
					"chargeable",
					"potentially_chargeable",
					"charges_waived",
					"exempt",
					"charges_not_applicable"
				],
				"type": "string"
			},
			"LaneRentalAssessmentChargeBand": {
				"enum": [
					"charge_band_1",
					"charge_band_2",
					"charge_band_3",
					"charge_band_4",
					"charge_band_5"
				],
				"type": "string"
			},
			"PermitLaneRentalAssessmentUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"outcome": {
						"$ref": "#/components/schemas/LaneRentalAssessmentOutcome",
						"description": "Required"
					},
					"additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"charge_band": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LaneRentalAssessmentChargeBand"
							}
						],
						"nullable": true,
						"description": "Optional\nOnly validated when outcome = 'chargeable'"
					},
					"chargeable_days": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nOnly validated when outcome = 'chargeable', and must then be a whole number between 1 and 10000"
					},
					"charges_agreed": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if outcome = 'chargeable', otherwise Optional\nWhether the lane rental charges have been agreed with the promoter"
					}
				},
				"required": [
					"outcome"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HS2AcknowledgementRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"hs2_acknowledged": {
						"type": "boolean",
						"description": "Required\nMust be true; any other value is rejected"
					}
				},
				"required": [
					"hs2_acknowledged"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DurationChallengeReviewStatus": {
				"enum": [
					"duration_challenge_accepted",
					"duration_challenge_not_accepted"
				],
				"type": "string"
			},
			"PermitDurationChallengeReviewRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"review_status": {
						"$ref": "#/components/schemas/DurationChallengeReviewStatus",
						"description": "Required\nCan only be set to duration_challenge_accepted or duration_challenge_not_accepted"
					},
					"reason_for_non_acceptance": {
						"type": "string",
						"nullable": true,
						"description": "Required if review_status is duration_challenge_not_accepted\nMax length 500 characters\nNot stored if review_status is duration_challenge_accepted"
					}
				},
				"required": [
					"review_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DurationChallengeNonAcceptanceResponseStatus": {
				"enum": [
					"reasonable_period_end_date_changed",
					"reasonable_period_end_date_not_changed"
				],
				"type": "string"
			},
			"PermitDurationChallengeNonAcceptanceResponseRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"non_acceptance_response_status": {
						"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatus",
						"description": "Required\nCan only be set to reasonable_period_end_date_changed or reasonable_period_end_date_not_changed"
					},
					"new_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if non_acceptance_response_status is reasonable_period_end_date_changed\nNot stored if non_acceptance_response_status is reasonable_period_end_date_not_changed"
					},
					"non_acceptance_response_details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"non_acceptance_response_status",
					"non_acceptance_response_details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CurrentTrafficManagementTypeRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"current_traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType",
						"description": "Required\nMust not be a higher priority than the traffic management type on the permit. From highest to lowest priority: road_closure, contra_flow, lane_closure, convoy_workings, multi_way_signals, two_way_signals, stop_go_boards, temp_obstruction_15_minute_delay, priority_working, give_and_take, some_carriageway_incursion, no_carriageway_incursion"
					},
					"current_traffic_management_emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if current_traffic_management_type is multi_way_signals or two_way_signals, otherwise Optional and any value supplied is discarded\nMax length 100 characters\nMust not be empty when required"
					},
					"current_traffic_management_emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Required if current_traffic_management_type is multi_way_signals or two_way_signals, otherwise Optional and any value supplied is discarded\nMax length 100 characters\nMust not be empty when required"
					}
				},
				"required": [
					"current_traffic_management_type"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DurationCalculationResponse": {
				"properties": {
					"calendar_days": {
						"type": "number",
						"format": "double",
						"description": "Inclusive number of calendar days from start_date to end_date (UK time)"
					},
					"working_days": {
						"type": "number",
						"format": "double",
						"description": "Inclusive number of days from start_date to end_date that are not weekends or England and Wales bank holidays"
					}
				},
				"required": [
					"calendar_days",
					"working_days"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkCategoryResponse": {
				"properties": {
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponseEnum",
						"description": "Required\nThe calculated work category"
					},
					"work_category_string": {
						"type": "string",
						"description": "Required\nThe calculated work category as a string"
					},
					"duration": {
						"$ref": "#/components/schemas/DurationCalculationResponse",
						"description": "Required\nCalendar and working days between the proposed start and end dates"
					},
					"validity_period_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nOnly calculated for major, standard (5 working days) and minor (2 working days) categories, otherwise the proposed start date"
					},
					"is_early_start": {
						"type": "boolean",
						"description": "Required\nOnly ever true for planned works"
					}
				},
				"required": [
					"work_category",
					"work_category_string",
					"duration",
					"validity_period_end_date",
					"is_early_start"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitSummaryResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the permit."
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed start date from the current version of the permit."
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed end date from the current version of the permit."
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe actual start date recorded against the permit. Not set until work has started."
					},
					"actual_stop_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe actual stop date recorded against the permit. Not set until work has stopped."
					},
					"permit_status": {
						"$ref": "#/components/schemas/PermitStatusResponse",
						"description": "Required\nThe current status of the permit."
					},
					"permit_status_string": {
						"type": "string",
						"description": "Required\nThe current status of the permit, as text."
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponseEnum",
						"description": "Required\nThe work category from the current version of the permit."
					},
					"work_category_string": {
						"type": "string",
						"description": "Required\nThe work category from the current version of the permit, as text."
					}
				},
				"required": [
					"permit_reference_number",
					"proposed_start_date",
					"proposed_end_date",
					"permit_status",
					"permit_status_string",
					"work_category",
					"work_category_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MarkPermitAsUnderAssessmentRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					}
				},
				"type": "object",
				"additionalProperties": false
			},
			"PermitNonComplianceLinkRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"non_compliance_reference_number": {
						"type": "string",
						"description": "Required\nMax length 106 characters\nNot case-sensitive"
					}
				},
				"required": [
					"non_compliance_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"IndustrySectorResponse": {
				"enum": [
					"electric",
					"water",
					"gas",
					"telecoms",
					"transport",
					"highway_authority",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ForwardPlanStatusResponse": {
				"enum": [
					"raised",
					"cancelled",
					"progressed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ForwardPlanSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"forward_plan_reference_number": {
						"type": "string"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"forward_plan_status": {
						"$ref": "#/components/schemas/ForwardPlanStatusResponse"
					},
					"forward_plan_status_string": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"forward_plan_reference_number",
					"start_date",
					"end_date",
					"forward_plan_status",
					"forward_plan_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AuditEvent": {
				"enum": [
					"historic_action",
					"inspection_passed",
					"inspection_failed",
					"inspection_unable_to_carry_out",
					"inspection_further_required",
					"inspection_agreed_site_compliance",
					"inspection_withdraw_defect",
					"activity_submitted",
					"activity_edited",
					"activity_cancelled",
					"fpn_submitted",
					"fpn_accepted",
					"fpn_paid",
					"fpn_disputed",
					"fpn_withdrawn",
					"permit_granted",
					"permit_refused",
					"permit_cancelled",
					"permit_revoked",
					"permit_deemed",
					"paa_granted",
					"paa_refused",
					"paa_cancelled",
					"paa_revoked",
					"alteration_submitted",
					"alteration_refused",
					"alteration_granted",
					"alteration_granted_with_duration_challenge",
					"alteration_deemed",
					"alteration_cancelled",
					"lane_rental_assessed",
					"reinstatement_submitted",
					"file_uploaded",
					"comment_submitted",
					"work_start_logged",
					"work_stop_logged",
					"work_start_reverted",
					"work_stop_reverted",
					"forward_plan_submitted",
					"forward_plan_cancelled",
					"user_removed",
					"user_invited",
					"user_name_updated",
					"inspection_units_logged",
					"permit_submitted",
					"paa_submitted",
					"forward_plan_edited",
					"permit_discount_updated",
					"paa_discount_updated",
					"paa_deemed",
					"organisation_contract_added",
					"organisation_contract_removed",
					"organisation_updated",
					"workstream_created",
					"workstream_updated",
					"inspection_works_stopped",
					"inspection_works_stopped_apparatus_remaining",
					"inspection_works_in_progress",
					"inspection_works_in_progress_no_carriageway_incursion",
					"inspection_non_compliant_with_conditions",
					"permit_modification_request",
					"scheduled_inspection_cancelled",
					"scheduled_inspection_created",
					"alteration_applied_auto",
					"section_81_submitted",
					"final_reinstatement_updated",
					"section_81_acknowledged",
					"section_81_accepted",
					"section_81_accepted_fixed",
					"section_81_rejected",
					"section_81_resolved_by_ha",
					"section_81_cancelled",
					"support_desk_action",
					"permit_hs2_acknowledged",
					"geographical_area_created",
					"geographical_area_updated",
					"workstream_access_updated",
					"planned_works_record_created",
					"in_progress_works_record_created",
					"historic_works_record_created",
					"non_notifiable_works_record_created",
					"section_81_works_record_created",
					"unattributable_works_record_created",
					"upcoming_event",
					"sample_inspection_target_created",
					"sample_inspection_target_updated",
					"sample_inspection_created",
					"sample_inspection_completed",
					"sample_inspection_removed",
					"sample_inspection_expired",
					"internal_comment_submitted",
					"comment_read",
					"excavation_carried_out_updated",
					"sample_inspection_target_closed",
					"section_81_linked_to_permit",
					"section_81_unlinked_from_permit",
					"section_81_reassigned",
					"permit_granted_with_duration_challenge",
					"inspection_withdrawn",
					"section_74_warning_issued",
					"section_74_warning_acknowledged",
					"section_74_site_visited_and_rectified",
					"section_74_charges_ended",
					"section_74_warning_disputed",
					"section_74_withdrawn",
					"section_74_draft_invoice_issued",
					"section_74_resolved",
					"section_74_draft_invoice_acknowledged",
					"section_74_charge_under_review",
					"section_74_charge_agreed",
					"alteration_duration_challenge_accepted",
					"alteration_duration_challenge_not_accepted",
					"alteration_duration_challenge_non_acceptance_response",
					"permit_duration_challenge_accepted",
					"permit_duration_challenge_not_accepted",
					"permit_duration_challenge_non_acceptance_response",
					"section_58_created",
					"section_58_progressed",
					"section_58_cancelled",
					"section_58_closed",
					"reinstatement_deleted",
					"site_deleted",
					"inspection_deleted",
					"site_subsumed",
					"fpn_deleted",
					"current_traffic_management_type_updated",
					"ancillary_info_added",
					"ancillary_info_removed",
					"sample_inspection_issued",
					"inspection_outcome_accepted",
					"inspection_outcome_disputed",
					"inspection_outcome_promoter_accepts_failed_inspection",
					"sample_inspection_target_deleted",
					"sample_inspection_quarter_started",
					"sample_inspection_quarter_ended",
					"fee_matrix_updated",
					"organisation_fpn_details_updated",
					"inspection_auto_accepted",
					"sample_inspection_quarter_end_reverted",
					"private_street_notice_issued",
					"private_street_notice_cancelled",
					"non_compliance_issued",
					"non_compliance_withdrawn",
					"non_compliance_resolved",
					"inspection_linked_to_non_compliance",
					"permit_linked_to_non_compliance",
					"inspection_outcome_joint_site_meeting_needed",
					"inspection_outcome_reviewing_dispute",
					"inspection_outcome_no_agreement",
					"non_compliance_works_completed_and_passed",
					"non_compliance_joint_site_meeting_suggested",
					"non_compliance_will_attend_joint_site_meeting",
					"non_compliance_works_complete_ready_for_inspection",
					"non_compliance_joint_site_meeting_not_needed",
					"event_subscription_created",
					"event_subscription_removed",
					"material_classification_submitted",
					"non_compliance_accept_suggestion",
					"permit_under_assessment",
					"alteration_revoked",
					"change_request_submitted",
					"change_request_refused",
					"change_request_granted",
					"change_request_granted_with_duration_challenge",
					"change_request_deemed",
					"change_request_cancelled",
					"change_request_applied_auto",
					"change_request_duration_challenge_accepted",
					"change_request_duration_challenge_not_accepted",
					"change_request_duration_challenge_non_acceptance_response",
					"change_request_revoked"
				],
				"type": "string"
			},
			"WorkHistorySummaryResponse": {
				"properties": {
					"action_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the event was recorded."
					},
					"topic": {
						"type": "string",
						"description": "Required\nThe topic of the event, e.g. PERMIT, INSPECTION, FPN, WORK, COMMENT, SECTION_81."
					},
					"details": {
						"type": "string",
						"description": "Required\nDescription of the event. May be empty when no details were recorded."
					},
					"username": {
						"type": "string",
						"description": "Required\nThe username of the user who caused the event."
					},
					"event": {
						"$ref": "#/components/schemas/AuditEvent",
						"description": "Required\nThe event type. Returned as upcoming_event when the event is not yet known to this version of the API."
					},
					"event_string": {
						"type": "string",
						"description": "Required\nThe event name as recorded."
					},
					"object_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only returned when the event relates to a specific record\nThe reference number of the record the event relates to."
					},
					"update_id": {
						"type": "number",
						"format": "double",
						"description": "Required\nUnique identifier of the audit record. Events with the same date are ordered by this value, highest first."
					},
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only returned when the user supplied one with the original action\nInternal user identifier supplied by the user."
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only returned when the user supplied one with the original action\nInternal user name supplied by the user."
					},
					"parent_object_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only returned when the event relates to a child record\nThe reference number of the parent record."
					}
				},
				"required": [
					"action_date",
					"topic",
					"details",
					"username",
					"event",
					"event_string",
					"update_id"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementStatusResponse": {
				"enum": [
					"interim",
					"permanent",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ReinstatementTypeResponse": {
				"enum": [
					"excavation",
					"bar_holes",
					"core_holes",
					"pole_testing",
					"upcoming_enum"
				],
				"type": "string"
			},
			"SiteSummaryResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPermit reference number of the site's latest reinstatement. Has no value when that reinstatement has no permit reference."
					},
					"site_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the site. Always returned."
					},
					"reinstatement_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the site's latest reinstatement. Always returned."
					},
					"site_description": {
						"type": "string",
						"description": "Required\nLocation description from the site's latest reinstatement. Always returned."
					},
					"depth": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nDepth of the site's latest reinstatement. Has no value when none was recorded."
					},
					"length": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nLength of the site's latest reinstatement. Has no value when none was recorded."
					},
					"width": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nWidth of the site's latest reinstatement. Has no value when none was recorded."
					},
					"completed_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nReinstatement date of the site's latest reinstatement. Omitted when the site is subsumed."
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nEnd date of the site's latest reinstatement. Omitted when the site is subsumed."
					},
					"site_status": {
						"$ref": "#/components/schemas/ReinstatementStatusResponse",
						"description": "Required\nStatus of the site's latest reinstatement. Always returned. A status not yet recognised by the API is returned as upcoming_enum."
					},
					"site_status_string": {
						"type": "string",
						"description": "Required\nStatus of the site's latest reinstatement as text. Always returned."
					},
					"reinstatement_type": {
						"$ref": "#/components/schemas/ReinstatementTypeResponse",
						"description": "Required\nReinstatement type of the site. Always returned. A type not yet recognised by the API is returned as upcoming_enum."
					},
					"reinstatement_type_string": {
						"type": "string",
						"description": "Required\nReinstatement type of the site as text. Always returned."
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nNumber of holes of the site's latest reinstatement. Has no value when none was recorded."
					},
					"is_subsumed": {
						"type": "boolean",
						"description": "Required\nWhether the site has been subsumed. Always returned."
					},
					"subsume_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nReason the site was subsumed. Has no value when the site has no subsume reason."
					},
					"response_to_remedial_works": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nResponse to remedial works of the site's latest reinstatement. Has no value when none was recorded."
					},
					"base_courses_affected": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether base courses were affected, on the site's latest reinstatement. Has no value when none was recorded."
					}
				},
				"required": [
					"site_reference_number",
					"reinstatement_reference_number",
					"site_description",
					"site_status",
					"site_status_string",
					"reinstatement_type",
					"reinstatement_type_string",
					"is_subsumed"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionResponseTypeResponse": {
				"enum": [
					"inspection",
					"reinspection",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionTypeResponse": {
				"enum": [
					"live_site",
					"reinstatement",
					"non_compliance_follow_up",
					"section_81",
					"investigatory_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionStatusResponse": {
				"enum": [
					"recorded",
					"withdrawn",
					"scheduled",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionCategoryResponse": {
				"enum": [
					"a",
					"b",
					"c",
					"third_party",
					"routine",
					"joint_site_visit",
					"follow_up",
					"follow_up_completion",
					"site_occupancy",
					"conditions",
					"core_sample",
					"skid_resistance",
					"texture_depth",
					"surface_regularity",
					"trial_hole",
					"section_81_initial",
					"section_81_follow_up",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionOutcomeResponse": {
				"enum": [
					"passed",
					"unable_to_complete_inspection",
					"failed_low",
					"failed_high",
					"further_inspections_required",
					"agreed_site_compliance",
					"non_compliant_with_conditions",
					"works_stopped_apparatus_remaining",
					"works_in_progress_no_carriageway_incursion",
					"works_in_progress",
					"works_stopped",
					"failed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionOutcomeStatusTypeResponse": {
				"enum": [
					"inspection_outcome_accepted",
					"inspection_outcome_disputed",
					"inspection_outcome_promoter_accepts_failed_inspection",
					"joint_site_meeting_needed",
					"reviewing_dispute",
					"inspection_withdrawn",
					"no_agreement",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionSummaryResponse": {
				"properties": {
					"inspection_date": {
						"type": "string",
						"format": "date-time"
					},
					"inspection_response_type": {
						"$ref": "#/components/schemas/InspectionResponseTypeResponse"
					},
					"inspection_response_type_string": {
						"type": "string"
					},
					"inspection_reference_number": {
						"type": "string",
						"nullable": true
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionTypeResponse"
					},
					"inspection_type_string": {
						"type": "string"
					},
					"inspection_status": {
						"$ref": "#/components/schemas/InspectionStatusResponse"
					},
					"inspection_status_string": {
						"type": "string"
					},
					"inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategoryResponse"
							}
						],
						"nullable": true
					},
					"inspection_category_string": {
						"type": "string",
						"nullable": true
					},
					"inspection_outcome": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeResponse"
							}
						],
						"nullable": true
					},
					"inspection_outcome_string": {
						"type": "string",
						"nullable": true
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"auto_acceptance_due_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"ha_response_status": {
						"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
					},
					"ha_response_status_string": {
						"type": "string"
					},
					"ha_response_status_change_date": {
						"type": "string",
						"format": "date-time"
					},
					"ha_response_details": {
						"type": "string"
					},
					"promoter_response_status": {
						"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
					},
					"promoter_response_status_string": {
						"type": "string"
					},
					"promoter_response_status_change_date": {
						"type": "string",
						"format": "date-time"
					},
					"promoter_response_details": {
						"type": "string"
					},
					"is_auto_accepted": {
						"type": "boolean",
						"nullable": true
					},
					"non_compliance_reference_number": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"inspection_date",
					"inspection_response_type",
					"inspection_response_type_string",
					"inspection_type",
					"inspection_type_string",
					"inspection_status",
					"inspection_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"OffenceCodeResponse": {
				"enum": [
					"offence_code_05",
					"offence_code_06",
					"offence_code_08",
					"offence_code_09",
					"upcoming_enum"
				],
				"type": "string"
			},
			"FPNStatusResponse": {
				"enum": [
					"issued",
					"accepted",
					"paid",
					"paid_discounted",
					"disputed",
					"withdrawn",
					"upcoming_enum"
				],
				"type": "string"
			},
			"FPNSummaryResponse": {
				"properties": {
					"fpn_reference_number": {
						"type": "string"
					},
					"fpn_offence_type": {
						"$ref": "#/components/schemas/OffenceCodeResponse"
					},
					"fpn_offence_type_string": {
						"type": "string"
					},
					"issue_date_time": {
						"type": "string",
						"format": "date-time"
					},
					"fpn_status": {
						"$ref": "#/components/schemas/FPNStatusResponse"
					},
					"fpn_status_string": {
						"type": "string"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"fpn_reference_number",
					"fpn_offence_type",
					"fpn_offence_type_string",
					"issue_date_time",
					"fpn_status",
					"fpn_status_string",
					"status_changed_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81SeverityResponse": {
				"enum": [
					"high",
					"low",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section81StatusResponse": {
				"enum": [
					"issued",
					"acknowledged",
					"accepted",
					"accepted_fixed",
					"rejected",
					"resolved_by_ha",
					"cancelled",
					"reassigned",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section81TypeResponse": {
				"enum": [
					"tee_valve_access_covers",
					"cabinet",
					"marker_post",
					"pole_post",
					"overhead_cables_broken_low_encroaching_onto_highway",
					"unattributed_works_live_site",
					"unattributed_works_completed",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section81SummaryResponse": {
				"properties": {
					"section_81_reference_number": {
						"type": "string",
						"description": "Required\nAlways returned. Reference number of the Section 81."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways returned. Date and time the Section 81 was created."
					},
					"location_description": {
						"type": "string",
						"description": "Required\nAlways returned. In the single Section 81 response this is the location description entered on the Section 81; in the summary response it is that description followed by the street name and area."
					},
					"section_81_severity": {
						"$ref": "#/components/schemas/Section81SeverityResponse",
						"description": "Optional\nReturned only when section_81_type is not unattributed_works_completed or unattributed_works_live_site; omitted for those two types. A severity the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_severity_string": {
						"type": "string",
						"description": "Optional\nText form of section_81_severity; returned under the same conditions."
					},
					"section_81_status": {
						"$ref": "#/components/schemas/Section81StatusResponse",
						"description": "Required\nAlways returned. Current status of the Section 81. A status the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_status_string": {
						"type": "string",
						"description": "Required\nAlways returned. Text form of section_81_status."
					},
					"section_81_type": {
						"$ref": "#/components/schemas/Section81TypeResponse",
						"description": "Optional\nAlways returned by the API; a type the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_type_string": {
						"type": "string",
						"description": "Optional\nAlways returned by the API. Text form of section_81_type."
					}
				},
				"required": [
					"section_81_reference_number",
					"date_created",
					"location_description",
					"section_81_status",
					"section_81_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FileResponse": {
				"properties": {
					"file_id": {
						"type": "number",
						"format": "double",
						"description": "Required\nIdentifier of the file."
					},
					"name": {
						"type": "string",
						"description": "Required\nName of the file."
					},
					"created_date": {
						"type": "string",
						"format": "date-time"
					},
					"user_created_by": {
						"type": "string"
					},
					"swa_code": {
						"type": "string"
					},
					"organisation_name": {
						"type": "string"
					}
				},
				"required": [
					"file_id",
					"name",
					"created_date",
					"user_created_by",
					"swa_code",
					"organisation_name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionSummaryResponse": {
				"properties": {
					"pbi_sample_inspection_reference_number": {
						"type": "string"
					},
					"inspection_category": {
						"$ref": "#/components/schemas/InspectionCategoryResponse"
					},
					"inspection_category_string": {
						"type": "string"
					},
					"sample_expiry_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"pbi_sample_inspection_reference_number",
					"inspection_category",
					"inspection_category_string",
					"sample_expiry_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"OverrunWarningReasonResponse": {
				"enum": [
					"more_than_five_slg_items_left_on_site",
					"five_or_less_slg_items_left_on_site",
					"open_excavation",
					"spoil_left_on_site",
					"missing_road_markings",
					"missing_street_apparatus",
					"active_traffic_management",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section74HAStatusResponse": {
				"enum": [
					"warning_issued",
					"charges_ended",
					"warning_disputed",
					"withdrawn",
					"draft_invoice_issued",
					"resolved",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section74SummaryResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the permit the Section 74 was issued against."
					},
					"section_74_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the Section 74, in the format {works reference number}-S74-{number}."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the Section 74 was created."
					},
					"overrun_warning_reasons": {
						"items": {
							"$ref": "#/components/schemas/OverrunWarningReasonResponse"
						},
						"type": "array",
						"description": "Required\nThe reasons the overrun warning was issued. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"overrun_warning_reasons_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nThe reasons the overrun warning was issued, as text."
					},
					"ha_status": {
						"$ref": "#/components/schemas/Section74HAStatusResponse",
						"description": "Required\nThe current highway authority status of the Section 74. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"ha_status_string": {
						"type": "string",
						"description": "Required\nThe current highway authority status of the Section 74, as text."
					}
				},
				"required": [
					"permit_reference_number",
					"section_74_reference_number",
					"date_created",
					"overrun_warning_reasons",
					"overrun_warning_reasons_string",
					"ha_status",
					"ha_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetStatusResponse": {
				"enum": [
					"cancelled",
					"issued",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PrivateStreetSummaryResponse": {
				"properties": {
					"private_street_reference_number": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"private_street_status": {
						"$ref": "#/components/schemas/PrivateStreetStatusResponse"
					},
					"private_street_status_string": {
						"type": "string"
					}
				},
				"required": [
					"private_street_reference_number",
					"proposed_start_date",
					"proposed_end_date",
					"private_street_status",
					"private_street_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CommentTopicResponse": {
				"enum": [
					"general",
					"section_74",
					"inspection",
					"fpn",
					"overrun",
					"forward_plan",
					"change_request",
					"imposed_variation",
					"duration_challenge",
					"section_81",
					"unattributed_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CommentResponse": {
				"properties": {
					"comment_reference_number": {
						"type": "string"
					},
					"comment_topic": {
						"$ref": "#/components/schemas/CommentTopicResponse"
					},
					"comment_topic_string": {
						"type": "string"
					},
					"detail": {
						"type": "string",
						"description": "Replaced with the text 'Internal comment' when the comment is internal and your organisation did not author it"
					},
					"author_email_address": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"is_read": {
						"type": "boolean"
					},
					"read_by": {
						"type": "string",
						"nullable": true,
						"description": "Only populated when the comment has been marked as read"
					},
					"read_on": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Only populated when the comment has been marked as read"
					},
					"is_internal": {
						"type": "boolean"
					},
					"author_organisation_ref": {
						"type": "string",
						"description": "SWA code of the authoring organisation, zero-padded to 4 characters"
					}
				},
				"required": [
					"comment_topic",
					"comment_topic_string",
					"detail",
					"author_email_address",
					"date_created"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the works."
					},
					"workstream_prefix": {
						"type": "string",
						"description": "Required\nThe prefix of the workstream the works belongs to."
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nThe SWA code of the promoter organisation, zero-padded to 4 characters."
					},
					"promoter_organisation": {
						"type": "string",
						"description": "Required\nThe name of the promoter organisation."
					},
					"promoter_organisation_industry_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/IndustrySectorResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe industry sector of the promoter organisation. Not set when the organisation has no industry sector."
					},
					"promoter_organisation_industry_type_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe industry sector of the promoter organisation as text. Not set when the organisation has no industry sector."
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nThe SWA code of the highway authority organisation, zero-padded to 4 characters."
					},
					"highway_authority": {
						"type": "string",
						"description": "Required\nThe name of the highway authority organisation."
					},
					"street_name": {
						"type": "string",
						"description": "Required\nThe name of the street."
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe town of the street. Not set when none is recorded."
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe area name of the street. Not set when none is recorded."
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"description": "Required\nThe road category of the street."
					},
					"road_category_is_active": {
						"type": "boolean",
						"description": "Optional\nWhether the road category is currently active. Not set when this is unknown."
					},
					"works_coordinates": {
						"description": "Required\nThe coordinates of the works as GeoJSON."
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nThe USRN of the street."
					},
					"inspection_units": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nThe inspection units for the works. Returned as 0 when none have been recorded."
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse",
						"description": "Required\nThe status of the works."
					},
					"work_status_string": {
						"type": "string",
						"description": "Required\nThe status of the works as text."
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nThe latest location description of the works."
					},
					"work_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe start date of the works. Not set when the works has no start date yet."
					},
					"work_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe end date of the works. Not set when the works has no end date yet."
					},
					"work_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe start time of the works. Not set when the works has no start time yet."
					},
					"work_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe end time of the works. Not set when the works has no end time yet."
					},
					"description_of_work": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe latest description of the works. Not set when none is recorded."
					},
					"active_permit": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PermitResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe most recently created permit on the works, with full details. Only present when the works has at least one permit."
					},
					"forward_plan": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ForwardPlanSummaryResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe forward plan for the works. Only present when the works has a forward plan."
					},
					"permits": {
						"items": {
							"$ref": "#/components/schemas/PermitSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the permits on the works, most recently created first, up to 50. Null when the works has no permits."
					},
					"history": {
						"items": {
							"$ref": "#/components/schemas/WorkHistorySummaryResponse"
						},
						"type": "array",
						"description": "Required\nThe most recent history events for the works, newest first, up to 5."
					},
					"sites": {
						"items": {
							"$ref": "#/components/schemas/SiteSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the sites on the works, newest first, up to 50. Empty when the works has no sites."
					},
					"inspections": {
						"items": {
							"$ref": "#/components/schemas/InspectionSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the inspections on the works, most recent first, up to 50. Empty when the works has none."
					},
					"fpns": {
						"items": {
							"$ref": "#/components/schemas/FPNSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the fixed penalty notices on the works, most recently issued first, up to 50. Empty when the works has none."
					},
					"section_81": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section81SummaryResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe section 81 summary for the works. Null when the works has none."
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nThe files attached to the works, newest first. Null when there are none."
					},
					"pbi_sample_inspections": {
						"items": {
							"$ref": "#/components/schemas/PbiSampleInspectionSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nThe issued sample inspections for the works. Only present when at least one has been issued."
					},
					"number_of_sites": {
						"type": "number",
						"format": "double",
						"description": "Optional\nThe total number of sites on the works. Not limited to the number of sites returned in the sites list."
					},
					"section74s": {
						"items": {
							"$ref": "#/components/schemas/Section74SummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the section 74s on the works, newest first, up to 50. Empty when the works has none."
					},
					"street_line": {
						"description": "Optional\nThe street geometry as GeoJSON. Only present when the street has one."
					},
					"private_street_notice": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PrivateStreetSummaryResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe private street notice for the works. Only present when one exists."
					},
					"non_compliances": {
						"items": {
							"$ref": "#/components/schemas/NonComplianceSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the non-compliances on the works. Present when the works has been checked for non-compliances."
					},
					"latest_comments": {
						"items": {
							"$ref": "#/components/schemas/CommentResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nThe most recent comments on the works, newest first. Comments marked internal by another organisation show the text Internal comment."
					}
				},
				"required": [
					"work_reference_number",
					"workstream_prefix",
					"promoter_swa_code",
					"promoter_organisation",
					"highway_authority_swa_code",
					"highway_authority",
					"street_name",
					"road_category",
					"works_coordinates",
					"usrn",
					"work_status",
					"work_status_string",
					"works_location_description",
					"history"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"work_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 24 characters\nMust be unique in the system\nMust contain only alphanumeric characters, dashes and underscores\nIf not supplied it will be auto-generated"
					},
					"secondary_contact": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_number": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe maximum date range between proposed_start_date and proposed_end_date is 5 years"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nRequired if proposed_start_date is in the past or work_type = immediate"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be on or after proposed_start_date\nThe maximum date range between proposed_start_date and proposed_end_date is 5 years"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nRequired if proposed_end_date is in the past\nMust be after the date and time for proposed_start_time"
					},
					"description_of_work": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"excavation": {
						"type": "boolean",
						"description": "Required\nWhether an excavation will be required"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"traffic_management_plan": {
						"type": "boolean",
						"description": "Required"
					},
					"lane_rental_applicable": {
						"type": "boolean",
						"description": "Required"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitCondition"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray values must be unique"
					},
					"collaborative_working": {
						"type": "boolean",
						"description": "Required"
					},
					"collaboration_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired if collaborative_working = true\nMax length 500 characters"
					},
					"collaborative_works": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly saved if collaborative_working = true\nMax length 500 characters\nWork Reference Number of collaborative works"
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityType",
						"description": "Required"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType",
						"description": "Required"
					},
					"application_type": {
						"$ref": "#/components/schemas/ApplicationType",
						"description": "Required"
					},
					"collaboration_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/CollaborationType"
							}
						],
						"nullable": true,
						"description": "Optional",
						"deprecated": true
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nArray values must be unique\nAt least one value is required"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray values must be unique\nArray max length 50 items\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"permit_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASD"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional"
					},
					"work_type": {
						"$ref": "#/components/schemas/WorkType",
						"description": "Required"
					},
					"is_ttro_required": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired when work_type is planned"
					},
					"immediate_risk": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired when work_type is immediate"
					},
					"early_start_pre_approval": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired when the dates supplied make the works an early start\nSee business rules section 2.1.4.6 - Early start"
					},
					"pre_approval_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired if early_start_pre_approval = true\nMax length 500 characters"
					},
					"pre_approval_authoriser": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired if early_start_pre_approval = true\nMax length 100 characters"
					},
					"early_start_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired if early_start_pre_approval = false\nMax length 500 characters"
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootway",
						"description": "Required"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpath",
						"description": "Required"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"workstream_prefix": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMust consist of 3 positive whole numbers and must not be 000\nMust be a workstream that exists in the organisation identified by promoter_swa_code"
					},
					"hs2_in_act_limits": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired if promoter_swa_code = '7374'"
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must occur today or a date in the future"
					},
					"hs2_highway_exemption": {
						"allOf": [
							{
								"$ref": "#/components/schemas/HS2HighwayExemption"
							}
						],
						"nullable": true,
						"description": "Optional\nRequired if work_type = 'hs2_highway_works' and hs2_in_act_limits = true"
					},
					"hs2_highway_emails": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray Max length 2 items\nArray values must be valid email addresses\nArray values max length 100 characters"
					},
					"additional_contact": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"hs2_additional_usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray max length 10 items\nArray values must be valid USRNs"
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nRequired if traffic_management_type = 'multi_way_signals' or 'two_way_signals'"
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nRequired if traffic_management_type = 'multi_way_signals' or 'two_way_signals'"
					},
					"is_primary_promoter": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired if collaborative_working is true"
					},
					"collaboration_types": {
						"items": {
							"$ref": "#/components/schemas/CollaborationType"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if collaborative_working is true or others_can_collaborate_on_work is true"
					},
					"primary_promoter_permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nIf collaborative_working is true and is_primary_promoter is false, the permit is linked to this permit reference"
					},
					"collaboration_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nRequired if collaborative_working is true or others_can_collaborate_on_work is true"
					},
					"collaboration_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nAt least one of collaboration_contact_email or collaboration_contact_phone_number is required when collaboration_contact_name is required"
					},
					"collaboration_contact_phone_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nAt least one of collaboration_contact_email or collaboration_contact_phone_number is required when collaboration_contact_name is required"
					},
					"estimated_number_of_network_days_saved": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if is_primary_promoter is false\nWhole number, 0 or more"
					},
					"others_can_collaborate_on_work": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired if collaborative_working is false"
					},
					"reason_for_non_collaboration": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters\nRequired if others_can_collaborate_on_work is false"
					},
					"can_collaborate_on_work_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters\nRequired if others_can_collaborate_on_work is true"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"secondary_contact",
					"secondary_contact_number",
					"proposed_start_date",
					"proposed_end_date",
					"description_of_work",
					"excavation",
					"traffic_management_plan",
					"lane_rental_applicable",
					"collaborative_working",
					"activity_type",
					"traffic_management_type",
					"application_type",
					"location_types",
					"work_type",
					"close_footway",
					"close_footpath",
					"works_location_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkStartUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate and time must be now or in the past\nMust be no more than 5 years before or after the proposed start date of the works' latest permit (proposed start time is used when the permit has one)\nValidated only when the works has a permit; if it has no permit the request is refused because a permit must be present"
					}
				},
				"required": [
					"actual_start_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkStartRevertRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"revert_reason": {
						"type": "string",
						"description": "Required\nMax length 500 characters\nMust not be empty"
					}
				},
				"required": [
					"revert_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkStopUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"actual_stop_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be before the current date and time\nMust be after the actual start date of the active permit\nMust be no more than 1826 days after the actual start date of the active permit\nThe works must be in progress and must not already have an actual stop date"
					}
				},
				"required": [
					"actual_stop_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkStopRevertRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"revert_reason": {
						"type": "string",
						"description": "Required, must not be empty, max length 500 characters\nThe works must be completed (412 otherwise)"
					}
				},
				"required": [
					"revert_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PaginationDetails": {
				"properties": {
					"total_rows": {
						"type": "number",
						"format": "double",
						"description": "Required\nTotal number of matching rows. Counting stops at 501, so a value of 501 means 501 or more."
					},
					"has_next_page": {
						"type": "boolean",
						"description": "Required\nTrue when more rows are available after this page."
					}
				},
				"required": [
					"total_rows",
					"has_next_page"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkHistoryResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationDetails",
						"description": "Required\nPaging details for the returned rows."
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/WorkHistorySummaryResponse"
						},
						"type": "array",
						"description": "Required\nThe history events for the works, newest first. Always returned; empty when the works has no history. At most 25 rows per page (500 for the all-history endpoint)."
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"SiteCreateResponse": {
				"properties": {
					"site_reference_number": {
						"type": "string"
					},
					"reinstatement_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"site_reference_number",
					"reinstatement_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementType": {
				"enum": [
					"excavation",
					"bar_holes",
					"core_holes",
					"pole_testing"
				],
				"type": "string"
			},
			"ReinstatementStatus": {
				"enum": [
					"interim",
					"permanent"
				],
				"type": "string"
			},
			"SiteCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"reinstatement_status": {
						"$ref": "#/components/schemas/ReinstatementStatus",
						"description": "Required\nWhether the reinstatement is interim or permanent\nA permanent reinstatement can only be added to an interim site under a new permit\nSee business rules section 2.10.4 - Making interim sites permanent"
					},
					"reinstatement_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be now or in the past\nFor excavation sites, must be on or after the actual start date of the earliest permit on the works"
					},
					"depth": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 99.99 inclusive, to two decimal places"
					},
					"length": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 9999.99 inclusive, to two decimal places"
					},
					"width": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 99.99 inclusive, to two decimal places"
					},
					"reinstatement_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nA point must contain a single coordinate pair"
					},
					"secondary_reinstatement_coordinates": {
						"nullable": true,
						"description": "Optional\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon, if provided\nA point must contain a single coordinate pair"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nHS2 location types cannot be used"
					},
					"reinstatement_evidence": {
						"type": "boolean",
						"description": "Required\nWhether reinstatement evidence has been supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if reinstatement_evidence is true, otherwise ignored\nMust contain between 1 and 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"final_reinstatement": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nWhether it is a final reinstatement"
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is not excavation, otherwise ignored\nMust be a whole number between 0 and 100 inclusive"
					},
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reference number of the permit the reinstatement is made under\nIf not provided, the active permit on the works is used"
					},
					"reinstatement_type": {
						"$ref": "#/components/schemas/ReinstatementType",
						"description": "Required\nThe type of reinstatement\nDetermines which of depth, length, width, final_reinstatement and number_of_holes are required\nAn excavation reinstatement requires an excavation to have been carried out on the works\nSee business rules section 2.10.2 - Reinstatement types"
					}
				},
				"required": [
					"reinstatement_status",
					"reinstatement_date",
					"reinstatement_coordinates",
					"location_description",
					"location_types",
					"reinstatement_evidence",
					"reinstatement_type"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementResponse": {
				"properties": {
					"reinstatement_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the reinstatement. Always returned."
					},
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPermit reference number linked to the reinstatement. Has no value when none is linked."
					},
					"reinstatement_status": {
						"$ref": "#/components/schemas/ReinstatementStatusResponse",
						"description": "Required\nStatus of the reinstatement. Always returned. A status not yet recognised by the API is returned as upcoming_enum."
					},
					"reinstatement_status_string": {
						"type": "string",
						"description": "Required\nStatus of the reinstatement as text. Always returned."
					},
					"reinstatement_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate of the reinstatement. Omitted when the site is subsumed and this is the active reinstatement."
					},
					"depth": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nDepth of the reinstatement. Has no value when none was recorded."
					},
					"length": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nLength of the reinstatement. Has no value when none was recorded."
					},
					"width": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nWidth of the reinstatement. Has no value when none was recorded."
					},
					"reinstatement_coordinates": {
						"description": "Required\nCoordinates (GeoJSON) of the reinstatement. Always returned."
					},
					"secondary_reinstatement_coordinates": {
						"nullable": true,
						"description": "Optional\nSecondary coordinates (GeoJSON) of the reinstatement. Null when none were recorded."
					},
					"location_description": {
						"type": "string",
						"description": "Required\nLocation description of the reinstatement. Always returned."
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nEnd date of the reinstatement. Omitted when the site is subsumed and this is the active reinstatement."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate the reinstatement was created. Always returned."
					},
					"date_modified": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate the reinstatement was last modified. Always returned."
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nLocation types of the reinstatement. Always returned; empty when none."
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nLocation types of the reinstatement as text. Always returned; empty when none."
					},
					"reinstatement_evidence": {
						"type": "boolean",
						"description": "Required\nWhether reinstatement evidence was provided. Always returned."
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nFiles attached to the reinstatement, newest first. Present when files are returned with the reinstatement (an empty list when it has none); omitted otherwise."
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nNumber of holes. Has no value when none was recorded."
					},
					"is_active_reinstatement": {
						"type": "boolean",
						"description": "Required\nWhether this is the site's active reinstatement. Always returned."
					},
					"response_to_remedial_works": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nResponse to remedial works. Has no value when none was recorded."
					},
					"base_courses_affected": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether base courses were affected. Has no value when none was recorded."
					}
				},
				"required": [
					"reinstatement_reference_number",
					"reinstatement_status",
					"reinstatement_status_string",
					"reinstatement_coordinates",
					"location_description",
					"date_created",
					"date_modified",
					"location_types",
					"location_types_string",
					"reinstatement_evidence",
					"is_active_reinstatement"
				],
				"type": "object",
				"additionalProperties": false
			},
			"SiteResponse": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPermit reference number of the site's latest reinstatement. Has no value when that reinstatement has no permit reference."
					},
					"site_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the site. Always returned."
					},
					"reinstatement_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the site's latest reinstatement. Always returned."
					},
					"site_description": {
						"type": "string",
						"description": "Required\nLocation description from the site's latest reinstatement. Always returned."
					},
					"depth": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nDepth of the site's latest reinstatement. Has no value when none was recorded."
					},
					"length": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nLength of the site's latest reinstatement. Has no value when none was recorded."
					},
					"width": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nWidth of the site's latest reinstatement. Has no value when none was recorded."
					},
					"completed_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nReinstatement date of the site's latest reinstatement. Omitted when the site is subsumed."
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nEnd date of the site's latest reinstatement. Omitted when the site is subsumed."
					},
					"site_status": {
						"$ref": "#/components/schemas/ReinstatementStatusResponse",
						"description": "Required\nStatus of the site's latest reinstatement. Always returned. A status not yet recognised by the API is returned as upcoming_enum."
					},
					"site_status_string": {
						"type": "string",
						"description": "Required\nStatus of the site's latest reinstatement as text. Always returned."
					},
					"reinstatement_type": {
						"$ref": "#/components/schemas/ReinstatementTypeResponse",
						"description": "Required\nReinstatement type of the site. Always returned. A type not yet recognised by the API is returned as upcoming_enum."
					},
					"reinstatement_type_string": {
						"type": "string",
						"description": "Required\nReinstatement type of the site as text. Always returned."
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nNumber of holes of the site's latest reinstatement. Has no value when none was recorded."
					},
					"is_subsumed": {
						"type": "boolean",
						"description": "Required\nWhether the site has been subsumed. Always returned."
					},
					"subsume_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nReason the site was subsumed. Has no value when the site has no subsume reason."
					},
					"response_to_remedial_works": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nResponse to remedial works of the site's latest reinstatement. Has no value when none was recorded."
					},
					"base_courses_affected": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether base courses were affected, on the site's latest reinstatement. Has no value when none was recorded."
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nLocation types of the site's latest reinstatement. Always returned; empty when none."
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nLocation types of the site's latest reinstatement as text. Always returned; empty when none."
					},
					"site_coordinates": {
						"description": "Required\nCoordinates (GeoJSON) of the site's latest reinstatement. Always returned."
					},
					"reinstatements": {
						"items": {
							"$ref": "#/components/schemas/ReinstatementResponse"
						},
						"type": "array",
						"description": "Required\nReinstatements recorded against the site. Always returned. Newest first. When retrieving a single site, a maximum of 50 reinstatements are returned."
					}
				},
				"required": [
					"site_reference_number",
					"reinstatement_reference_number",
					"site_description",
					"site_status",
					"site_status_string",
					"reinstatement_type",
					"reinstatement_type_string",
					"is_subsumed",
					"location_types",
					"location_types_string",
					"site_coordinates",
					"reinstatements"
				],
				"type": "object",
				"additionalProperties": false
			},
			"SubsumeSiteRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"subsume_reason": {
						"type": "string",
						"description": "Required\nReason the site is being subsumed. Must not be empty. Max length 500 characters"
					}
				},
				"required": [
					"subsume_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementCreateResponse": {
				"properties": {
					"reinstatement_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"reinstatement_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"reinstatement_status": {
						"$ref": "#/components/schemas/ReinstatementStatus",
						"description": "Required\nWhether the reinstatement is interim or permanent\nA permanent reinstatement can only be added to an interim site under a new permit\nSee business rules section 2.10.4 - Making interim sites permanent"
					},
					"reinstatement_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be now or in the past\nFor excavation sites, must be on or after the actual start date of the earliest permit on the works"
					},
					"depth": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 99.99 inclusive, to two decimal places"
					},
					"length": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 9999.99 inclusive, to two decimal places"
					},
					"width": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nIs number between 0 and 99.99 inclusive, to two decimal places"
					},
					"reinstatement_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nA point must contain a single coordinate pair"
					},
					"secondary_reinstatement_coordinates": {
						"nullable": true,
						"description": "Optional\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon, if provided\nA point must contain a single coordinate pair"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nHS2 location types cannot be used"
					},
					"reinstatement_evidence": {
						"type": "boolean",
						"description": "Required\nWhether reinstatement evidence has been supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if reinstatement_evidence is true, otherwise ignored\nMust contain between 1 and 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"final_reinstatement": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is excavation, otherwise ignored\nWhether it is a final reinstatement"
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nRequired if the reinstatement type is not excavation, otherwise ignored\nMust be a whole number between 0 and 100 inclusive"
					},
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reference number of the permit the reinstatement is made under\nIf not provided, the active permit on the works is used"
					},
					"response_to_remedial_works": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nMust be provided if base_courses_affected is provided\nOnly stored when both the existing site and this reinstatement are permanent"
					},
					"base_courses_affected": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nMust be provided if response_to_remedial_works is provided\nOnly stored when both the existing site and this reinstatement are permanent"
					}
				},
				"required": [
					"reinstatement_status",
					"reinstatement_date",
					"reinstatement_coordinates",
					"location_description",
					"location_types",
					"reinstatement_evidence"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FailureReasonResponse": {
				"enum": [
					"live_site_signage",
					"live_site_distance",
					"live_site_safety_zone",
					"live_site_barriers",
					"live_site_traffic_control",
					"live_site_pedestrian_provision",
					"live_site_cyclist_provision",
					"live_site_operative_qualification",
					"live_site_equipment",
					"live_site_materials",
					"live_site_compaction",
					"live_site_construction_layers",
					"live_site_storage_of_materials",
					"reinstatement_damage_to_surround_area",
					"reinstatement_saw_cutting",
					"reinstatement_acute_angles",
					"reinstatement_verge",
					"reinstatement_anti_skid",
					"reinstatement_fixed_features",
					"reinstatement_modular",
					"reinstatement_proximity",
					"reinstatement_materials_incorrect",
					"reinstatement_materials_damaged",
					"reinstatement_edge_sealant",
					"reinstatement_over_banding",
					"reinstatement_road_markings",
					"reinstatement_infill_pointing",
					"reinstatement_ironwork_apparatus",
					"reinstatement_breaking_out_fretting",
					"reinstatement_interface_cracking",
					"reinstatement_crowning",
					"reinstatement_depression",
					"reinstatement_as_laid_profile",
					"reinstatement_texture_depth",
					"reinstatement_edge_depression",
					"investigatory_air_void",
					"investigatory_material_type",
					"investigatory_layer_depth",
					"investigatory_contamination",
					"investigatory_other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"SiteDetails": {
				"properties": {
					"site_description": {
						"type": "string"
					},
					"site_reference_number": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"site_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FailureReasonDetailsResponse": {
				"properties": {
					"failure_reason": {
						"$ref": "#/components/schemas/FailureReasonResponse",
						"description": "Required\nThe non-compliant area."
					},
					"failure_reason_string": {
						"type": "string",
						"description": "Required\nThe non-compliant area as a string."
					},
					"sites": {
						"items": {
							"$ref": "#/components/schemas/SiteDetails"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSites the failure reason applies to. Only populated for inspection types that record sites; otherwise null."
					},
					"details": {
						"type": "string",
						"description": "Required\nFree text details of the non-compliance."
					},
					"site_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nName of the site the failure reason applies to. Null when not recorded."
					}
				},
				"required": [
					"failure_reason",
					"failure_reason_string",
					"details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DefectFixedOnsiteResponse": {
				"enum": [
					"yes_by_inspector",
					"yes_by_onsite_members",
					"no",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionReasonForWithdrawalResponse": {
				"enum": [
					"incorrect_outcome_recorded",
					"wrong_works_or_organisation",
					"wrong_details",
					"outcome_changed",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionResponse": {
				"properties": {
					"inspection_reference_number": {
						"type": "string",
						"description": "Required\nUnique reference of the inspection, e.g. {works reference number}-INSP-01."
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionTypeResponse",
						"description": "Required\nThe type of inspection."
					},
					"inspection_type_string": {
						"type": "string",
						"description": "Required\nThe type of inspection as a string."
					},
					"inspection_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date the inspection was carried out."
					},
					"inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategoryResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe inspection category. Only returned when the inspection has a category."
					},
					"inspection_category_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe inspection category as a string. Only returned when the inspection has a category."
					},
					"inspection_outcome": {
						"$ref": "#/components/schemas/InspectionOutcomeResponse",
						"description": "Required\nThe inspection outcome. May be absent where no outcome has been recorded on the inspection."
					},
					"inspection_outcome_string": {
						"type": "string",
						"description": "Required\nThe inspection outcome as a string. May be absent where no outcome has been recorded on the inspection."
					},
					"failure_reason_details": {
						"items": {
							"$ref": "#/components/schemas/FailureReasonDetailsResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nNon-compliant areas recorded for a failed inspection. Returned as an array on this endpoint (empty when there are none)."
					},
					"inspection_outcome_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nFree text details of the inspection outcome."
					},
					"was_call_logged": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether a call was logged."
					},
					"call_logged_to": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nWho the call was logged to."
					},
					"call_logged_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reference of the logged call."
					},
					"call_logged_summary": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nA summary of the logged call."
					},
					"defect_fixed_on_site": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DefectFixedOnsiteResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nWhether a defect was fixed on site. Only returned when recorded."
					},
					"defect_fixed_on_site_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nWhether a defect was fixed on site, as a string. Only returned when recorded."
					},
					"additional_comments": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAdditional comments on the inspection."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the inspection was created."
					},
					"date_modified": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the inspection was last modified."
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nFiles attached to the inspection. Returned as an array on this endpoint (empty when there are none)."
					},
					"work_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the works the inspection belongs to."
					},
					"reinspection_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nNot populated by the get inspection endpoint."
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nNot populated by the get inspection endpoint."
					},
					"username": {
						"type": "string",
						"description": "Required\nThe username of the user associated with the inspection."
					},
					"promoter_organisation": {
						"type": "string",
						"description": "Required\nThe name of the promoter organisation on the works."
					},
					"highway_authority": {
						"type": "string",
						"description": "Required\nThe name of the highway authority on the works."
					},
					"inspector_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe name of the inspector."
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional\nWhether the site was made safe by the highway authority."
					},
					"inspection_status": {
						"$ref": "#/components/schemas/InspectionStatusResponse",
						"description": "Required\nThe status of the inspection."
					},
					"inspection_status_string": {
						"type": "string",
						"description": "Required\nThe status of the inspection as a string."
					},
					"inspection_reason_for_withdrawal": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionReasonForWithdrawalResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe reason the inspection was withdrawn. Only returned for a withdrawn inspection."
					},
					"inspection_reason_for_withdrawal_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reason the inspection was withdrawn, as a string. Only returned for a withdrawn inspection."
					},
					"withdrawal_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nFree text details of why the inspection was withdrawn."
					},
					"promoter_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe promoter's response status to the inspection outcome. Only returned once a promoter response status exists."
					},
					"promoter_response_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe promoter's response status as a string. Only returned once a promoter response status exists."
					},
					"promoter_response_status_change_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date the promoter response status last changed. Only returned once a promoter response status exists."
					},
					"promoter_response_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe promoter's response details. Only returned when the promoter response status is disputed, accepted, or the promoter disagrees with an acceptance made on their behalf by the highway authority."
					},
					"ha_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe highway authority's response status to the inspection outcome. Only returned once a highway authority response status exists."
					},
					"ha_response_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe highway authority's response status as a string. Only returned once a highway authority response status exists."
					},
					"ha_response_status_change_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date the highway authority response status last changed. Only returned once a highway authority response status exists."
					},
					"ha_response_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe highway authority's response details. Only returned once a highway authority response status exists."
					},
					"auto_acceptance_due_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date the inspection outcome will be automatically accepted. Only returned when set."
					},
					"is_auto_accepted": {
						"type": "boolean",
						"description": "Required\nWhether the inspection outcome was automatically accepted."
					},
					"non_compliance_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nReference number of the non-compliance linked to the inspection. Only returned when the inspection is linked to one."
					}
				},
				"required": [
					"inspection_reference_number",
					"inspection_type",
					"inspection_type_string",
					"inspection_start_date",
					"inspection_outcome",
					"inspection_outcome_string",
					"date_created",
					"date_modified",
					"work_reference_number",
					"username",
					"promoter_organisation",
					"highway_authority",
					"inspection_status",
					"inspection_status_string",
					"is_auto_accepted"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionCreateResponse": {
				"properties": {
					"inspection_reference_number": {
						"type": "string"
					},
					"non_compliance_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"inspection_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionType": {
				"enum": [
					"live_site",
					"reinstatement",
					"non_compliance_follow_up",
					"section_81",
					"investigatory_works"
				],
				"type": "string"
			},
			"InspectionCategory": {
				"enum": [
					"a",
					"b",
					"c",
					"third_party",
					"routine",
					"joint_site_visit",
					"follow_up",
					"follow_up_completion",
					"site_occupancy",
					"conditions",
					"core_sample",
					"skid_resistance",
					"texture_depth",
					"surface_regularity",
					"trial_hole",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionOutcome": {
				"enum": [
					"passed",
					"unable_to_complete_inspection",
					"failed_low",
					"failed_high",
					"further_inspections_required",
					"agreed_site_compliance",
					"non_compliant_with_conditions",
					"works_stopped_apparatus_remaining",
					"works_in_progress_no_carriageway_incursion",
					"works_in_progress",
					"works_stopped",
					"failed"
				],
				"type": "string"
			},
			"FailureReason": {
				"enum": [
					"live_site_signage",
					"live_site_distance",
					"live_site_safety_zone",
					"live_site_barriers",
					"live_site_traffic_control",
					"live_site_pedestrian_provision",
					"live_site_cyclist_provision",
					"live_site_operative_qualification",
					"live_site_equipment",
					"live_site_materials",
					"live_site_compaction",
					"live_site_construction_layers",
					"live_site_storage_of_materials",
					"reinstatement_damage_to_surround_area",
					"reinstatement_saw_cutting",
					"reinstatement_acute_angles",
					"reinstatement_verge",
					"reinstatement_anti_skid",
					"reinstatement_fixed_features",
					"reinstatement_modular",
					"reinstatement_proximity",
					"reinstatement_materials_incorrect",
					"reinstatement_materials_damaged",
					"reinstatement_edge_sealant",
					"reinstatement_over_banding",
					"reinstatement_road_markings",
					"reinstatement_infill_pointing",
					"reinstatement_ironwork_apparatus",
					"reinstatement_breaking_out_fretting",
					"reinstatement_interface_cracking",
					"reinstatement_crowning",
					"reinstatement_depression",
					"reinstatement_as_laid_profile",
					"reinstatement_texture_depth",
					"reinstatement_edge_depression",
					"investigatory_air_void",
					"investigatory_material_type",
					"investigatory_layer_depth",
					"investigatory_contamination",
					"investigatory_other"
				],
				"type": "string"
			},
			"FailureReasonDetails": {
				"properties": {
					"failure_reason": {
						"$ref": "#/components/schemas/FailureReason",
						"description": "Required\nMust be a valid failure_reason for the inspection_type\nEach failure_reason in the array must be unique"
					},
					"site_reference_numbers": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if the inspection_type is reinstatement, non_compliance_follow_up or investigatory_works and the works has sites\nArray values must be unique\nEach value must be a site_reference_number that exists on the works"
					},
					"details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"failure_reason",
					"details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"DefectFixedOnsite": {
				"enum": [
					"yes_by_inspector",
					"yes_by_onsite_members",
					"no"
				],
				"type": "string"
			},
			"InspectionCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionType",
						"description": "Required\nSee business rules section 10.2 - Inspection types and categories"
					},
					"inspection_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be now or in the past"
					},
					"inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategory"
							}
						],
						"nullable": true,
						"description": "Required if inspection_type is not section_81, otherwise ignored\nMust be a valid category for the inspection_type\nSee business rules section 10.2 - Inspection types and categories"
					},
					"inspection_outcome": {
						"$ref": "#/components/schemas/InspectionOutcome",
						"description": "Required\nMust be a valid outcome for the inspection_category\nSee business rules section 10.3 - Inspection outcomes"
					},
					"failure_reason_details": {
						"items": {
							"$ref": "#/components/schemas/FailureReasonDetails"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if inspection_outcome = failed_high, failed_low or failed and inspection_type is not section_81, otherwise ignored\nMust contain at least one item\nEach failure_reason must be unique and valid for the inspection_type\nSee business rules section 10.3 - Inspection outcomes"
					},
					"inspection_outcome_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if inspection_outcome = unable_to_complete_inspection or non_compliant_with_conditions\nMax length 500 characters"
					},
					"was_call_logged": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if defect_fixed_on_site = no"
					},
					"call_logged_to": {
						"type": "string",
						"nullable": true,
						"description": "Required if defect_fixed_on_site = no and was_call_logged = true\nMax length 100 characters"
					},
					"call_logged_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly validated if defect_fixed_on_site = no and was_call_logged = true\nMax length 100 characters"
					},
					"call_logged_summary": {
						"type": "string",
						"nullable": true,
						"description": "Required if defect_fixed_on_site = no and was_call_logged = true\nMax length 500 characters"
					},
					"defect_fixed_on_site": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DefectFixedOnsite"
							}
						],
						"nullable": true,
						"description": "Required if inspection_outcome = failed_high or failed_low and inspection_type = live_site"
					},
					"additional_comments": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"inspection_evidence": {
						"type": "boolean",
						"description": "Required\nSet to true to attach files using file_ids"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if inspection_evidence = true, otherwise ignored\nArray values must be unique\nMust not contain null or undefined values\nMax 50 items\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"reinspection_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nMust occur today or a date in the future\nCreating the inspection replaces any scheduled inspection already on the works"
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date must match the date for reinspection_date\nMust be in the future"
					},
					"reinspection_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionType"
							}
						],
						"nullable": true,
						"description": "Optional\nUsed if reinspection_date is provided together with this and reinspection_category (or this is section_81)\nOtherwise the scheduled inspection takes the inspection_type value"
					},
					"reinspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategory"
							}
						],
						"nullable": true,
						"description": "Optional\nMust be a valid category for the reinspection_type\nUsed if reinspection_date is provided together with reinspection_type\nOtherwise the scheduled inspection takes the inspection_category value\nSee business rules section 10.2 - Inspection types and categories"
					},
					"username": {
						"type": "string",
						"description": "Required\nMax length 100 characters\nShould be populated with the user creating the inspection"
					},
					"inspector_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if inspection_type = section_81 and inspection_outcome = failed_high or failed_low"
					},
					"non_compliance_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 106 characters\nThe inspection is linked to the existing non-compliance with this reference number if inspection_type is reinstatement, non_compliance_follow_up or investigatory_works, otherwise ignored\nThe non-compliance must exist, belong to the same works and have a status of issued"
					}
				},
				"required": [
					"inspection_type",
					"inspection_start_date",
					"inspection_outcome",
					"inspection_evidence",
					"username"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionReasonForWithdrawal": {
				"enum": [
					"incorrect_outcome_recorded",
					"wrong_works_or_organisation",
					"wrong_details",
					"outcome_changed",
					"other"
				],
				"type": "string"
			},
			"InspectionWithdrawRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"reason_for_withdrawal": {
						"$ref": "#/components/schemas/InspectionReasonForWithdrawal",
						"description": "Required\nMust be one of the InspectionReasonForWithdrawal values: incorrect_outcome_recorded, wrong_works_or_organisation, wrong_details, outcome_changed, other"
					},
					"withdrawal_details": {
						"type": "string",
						"description": "Required\nMust not be empty. Max length 500 characters"
					}
				},
				"required": [
					"reason_for_withdrawal",
					"withdrawal_details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionOutcomeStatusType": {
				"enum": [
					"inspection_outcome_accepted",
					"inspection_outcome_disputed",
					"inspection_outcome_promoter_accepts_failed_inspection",
					"joint_site_meeting_needed",
					"reviewing_dispute",
					"no_agreement"
				],
				"type": "string"
			},
			"InspectionOutcomeStatusRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"inspection_response_type": {
						"$ref": "#/components/schemas/InspectionOutcomeStatusType",
						"description": "Required\nPlanner and Contractor users must use one of: inspection_outcome_accepted, inspection_outcome_disputed, joint_site_meeting_needed, inspection_outcome_promoter_disagrees_with_ha_acceptance_on_behalf\nHighway Authority users must use one of: inspection_outcome_promoter_accepts_failed_inspection, reviewing_dispute, no_agreement"
					},
					"inspection_response_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired if inspection_response_type is one of: inspection_outcome_disputed, inspection_outcome_promoter_accepts_failed_inspection, no_agreement, inspection_outcome_promoter_disagrees_with_ha_acceptance_on_behalf\nMax length 500 characters"
					}
				},
				"required": [
					"inspection_response_type"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ScheduledInspectionCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"scheduled_inspection_type": {
						"$ref": "#/components/schemas/InspectionType",
						"description": "Required\nMust be section_81 if the works is a Section 81 works, and must not be section_81 otherwise"
					},
					"scheduled_inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategory"
							}
						],
						"nullable": true,
						"description": "Optional, but required unless scheduled_inspection_type is section_81 (not used for section_81)\nMust be a valid category for the scheduled_inspection_type:\nreinstatement: third_party or routine\nlive_site: a, site_occupancy, conditions, third_party or routine\nnon_compliance_follow_up: joint_site_visit, follow_up or follow_up_completion\ninvestigatory_works: core_sample, skid_resistance, texture_depth, surface_regularity or trial_hole\nSee business rules section 4.1.2 - Inspection types and categories"
					},
					"scheduled_inspection_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate must occur today or a date in the future"
					},
					"scheduled_inspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date for scheduled_inspection_date_time must match the date for scheduled_inspection_date\nDate and time must occur in the future"
					}
				},
				"required": [
					"scheduled_inspection_type",
					"scheduled_inspection_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AuthenticationResponse": {
				"properties": {
					"idToken": {
						"type": "string",
						"nullable": true
					},
					"organisationReference": {
						"type": "string",
						"nullable": true
					},
					"accessToken": {
						"type": "string",
						"nullable": true
					},
					"refreshToken": {
						"type": "string",
						"nullable": true
					},
					"sessionToken": {
						"type": "string",
						"nullable": true
					}
				},
				"type": "object",
				"additionalProperties": false
			},
			"AuthenticationRequest": {
				"properties": {
					"emailAddress": {
						"type": "string"
					},
					"password": {
						"type": "string"
					}
				},
				"required": [
					"emailAddress",
					"password"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InitialAuthenticationResponse": {
				"properties": {
					"sessionToken": {
						"type": "string"
					}
				},
				"required": [
					"sessionToken"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PaymentMethodResponse": {
				"enum": [
					"bank_transfer",
					"card_payment",
					"cash",
					"cheque",
					"upcoming_enum"
				],
				"type": "string"
			},
			"FPNResponse": {
				"properties": {
					"fpn_reference_number": {
						"type": "string"
					},
					"fpn_offence_type": {
						"$ref": "#/components/schemas/OffenceCodeResponse"
					},
					"fpn_offence_type_string": {
						"type": "string"
					},
					"issue_date_time": {
						"type": "string",
						"format": "date-time"
					},
					"fpn_status": {
						"$ref": "#/components/schemas/FPNStatusResponse"
					},
					"fpn_status_string": {
						"type": "string"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"location": {
						"type": "string"
					},
					"offence_date": {
						"type": "string",
						"format": "date-time"
					},
					"offence_details": {
						"type": "string"
					},
					"authorised_officer": {
						"type": "string"
					},
					"officer_contact_details": {
						"type": "string"
					},
					"officer_address": {
						"type": "string",
						"nullable": true
					},
					"representations_contact": {
						"type": "string",
						"nullable": true
					},
					"representations_contact_address": {
						"type": "string",
						"nullable": true
					},
					"payment_methods": {
						"items": {
							"$ref": "#/components/schemas/PaymentMethodResponse"
						},
						"type": "array",
						"nullable": true
					},
					"payment_methods_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true
					},
					"work_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"ha_organisation": {
						"type": "string"
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true
					},
					"permit_reference_number": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"fpn_reference_number",
					"fpn_offence_type",
					"fpn_offence_type_string",
					"issue_date_time",
					"fpn_status",
					"fpn_status_string",
					"status_changed_date",
					"location",
					"offence_date",
					"offence_details",
					"authorised_officer",
					"officer_contact_details",
					"work_reference_number",
					"promoter_organisation",
					"ha_organisation"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FPNCreateResponse": {
				"properties": {
					"fpn_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"fpn_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"OffenceCode": {
				"enum": [
					"offence_code_05",
					"offence_code_06",
					"offence_code_08",
					"offence_code_09"
				],
				"type": "string"
			},
			"PaymentMethod": {
				"enum": [
					"bank_transfer",
					"card_payment",
					"cash",
					"cheque"
				],
				"type": "string"
			},
			"FPNCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"fpn_evidence": {
						"type": "boolean",
						"description": "Whether FPN evidence has been supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if fpn_evidence is true, and must contain at least one value\nMaximum of 50 values\nArray values must be unique\nMust not contain null or undefined values\nEach file must already have been uploaded, and a file can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"offence_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be now or a date and time in the past"
					},
					"offence_code": {
						"$ref": "#/components/schemas/OffenceCode"
					},
					"offence_details": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"authorised_officer": {
						"type": "string",
						"description": "Max length 100 characters"
					},
					"officer_contact_details": {
						"type": "string",
						"description": "Max length 100 characters"
					},
					"officer_address": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"representations_contact": {
						"type": "string",
						"description": "Max length 100 characters"
					},
					"representations_contact_address": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"payment_methods": {
						"items": {
							"$ref": "#/components/schemas/PaymentMethod"
						},
						"type": "array",
						"description": "Must contain at least one value\nArray values must be unique"
					},
					"permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "The permit_reference_number of the associated permit\nMust be a permit on the works record the fixed penalty notice is being issued against"
					}
				},
				"required": [
					"fpn_evidence",
					"offence_date",
					"offence_code",
					"offence_details",
					"authorised_officer",
					"officer_contact_details",
					"officer_address",
					"representations_contact",
					"representations_contact_address",
					"payment_methods"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FPNStatus": {
				"enum": [
					"issued",
					"accepted",
					"paid",
					"paid_discounted",
					"disputed",
					"withdrawn"
				],
				"type": "string"
			},
			"FPNStatusUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"fpn_status": {
						"$ref": "#/components/schemas/FPNStatus"
					},
					"status_reason": {
						"type": "string",
						"nullable": true,
						"description": "Required if fpn_status is withdrawn or disputed\nOptional if fpn_status is accepted\nMax length 500 characters\nNot stored when fpn_status is paid or paid_discounted"
					}
				},
				"required": [
					"fpn_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CommentCreateResponse": {
				"properties": {
					"comment_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"comment_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CommentTopic": {
				"enum": [
					"GENERAL",
					"SECTION_74",
					"INSPECTION",
					"FPN",
					"OVERRUN",
					"FORWARD_PLAN",
					"CHANGE_REQUEST",
					"IMPOSED_VARIATION",
					"DURATION_CHALLENGE",
					"SECTION_81",
					"UNATTRIBUTED_WORKS"
				],
				"type": "string"
			},
			"CommentCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"detail": {
						"type": "string",
						"description": "Max length 1500 characters\nMust not be empty"
					},
					"topic": {
						"$ref": "#/components/schemas/CommentTopic",
						"description": "Only highway authorities can comment with the topic OVERRUN"
					},
					"is_internal": {
						"type": "boolean",
						"nullable": true,
						"description": "Flag a comment as internal. Internal comments visible to members of authors organisation.\nDefaults to false if not provided."
					}
				},
				"required": [
					"detail",
					"topic"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CommentReadRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					}
				},
				"type": "object",
				"additionalProperties": false
			},
			"WorkCommentsResponse": {
				"properties": {
					"comments": {
						"items": {
							"$ref": "#/components/schemas/CommentResponse"
						},
						"type": "array",
						"description": "Ordered newest first, capped at 500 comments"
					},
					"more_rows_exist": {
						"type": "boolean",
						"description": "True when the works has more than 500 comments in total"
					}
				},
				"required": [
					"comments",
					"more_rows_exist"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitAlterationResponse": {
				"properties": {
					"permit_alteration_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"alteration_status": {
						"$ref": "#/components/schemas/AlterationStatusResponse"
					},
					"alteration_status_string": {
						"type": "string"
					},
					"alteration_type": {
						"$ref": "#/components/schemas/AlterationTypeResponse"
					},
					"alteration_type_string": {
						"type": "string"
					},
					"permit_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PermitStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional, only returned when the alteration has a permit status"
					},
					"permit_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional, the permit status as text"
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional, the assessment discount recorded for the alteration"
					},
					"assessment_comments": {
						"type": "string",
						"nullable": true,
						"description": "Optional, the assessment comments recorded for the alteration"
					},
					"permit_alteration_reason": {
						"type": "string",
						"description": "Required, the reason given for the alteration"
					},
					"original": {
						"$ref": "#/components/schemas/PermitResponse",
						"description": "Required, the permit as it was before the alteration"
					},
					"proposed": {
						"$ref": "#/components/schemas/PermitResponse",
						"description": "Required, the permit as proposed by the alteration"
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional, only returned when a duration challenge review status exists"
					},
					"duration_challenge_review_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional, the duration challenge review status as text"
					},
					"duration_challenge_reason_for_non_acceptance": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only returned when a reason for non-acceptance was recorded"
					},
					"duration_challenge_review_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, when the duration challenge review was last updated"
					},
					"duration_challenge_non_acceptance_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional, only returned when a response to the non-acceptance exists"
					},
					"duration_challenge_non_acceptance_response_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional, the response status to the non-acceptance as text"
					},
					"duration_challenge_non_acceptance_response_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional, details provided with the response to the non-acceptance"
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, when the response to the non-acceptance was last updated"
					},
					"duration_challenge_non_acceptance_response_new_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, the new reasonable period end date set in response to the non-acceptance"
					},
					"duration_challenge_non_acceptance_response_old_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, the previous reasonable period end date before the response to the non-acceptance"
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true,
						"description": "Optional, whether the follow-up review of the duration challenge is complete"
					}
				},
				"required": [
					"permit_alteration_reference_number",
					"date_created",
					"deadline_date",
					"alteration_status",
					"alteration_status_string",
					"alteration_type",
					"alteration_type_string",
					"permit_alteration_reason",
					"original",
					"proposed"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AddFileToWorkRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"description": "Required\nMaximum of 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nEach file_id must refer to an existing uploaded file\nA file_id can only be associated with one section of Street Manager; a file already linked to a works, inspection, permit/permit alteration, change request, FPN, reinstatement, section 81, section 74, private street notice or material classification is rejected with 412\nThe works' total files (existing plus these) must not exceed 50, otherwise 412 'File limit reached'\nSee API specification Resource Guide > Works API > File upload for more information"
					}
				},
				"required": [
					"file_ids"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityCreateResponse": {
				"properties": {
					"activity_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"activity_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityActivityType": {
				"enum": [
					"skips",
					"scaffolding",
					"hoarding",
					"crane_mobile_platform",
					"event",
					"section50",
					"section58",
					"compound",
					"other"
				],
				"type": "string"
			},
			"ActivityCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Is whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"activity_coordinates": {
						"description": "Must be a valid GeoJSON geometry of type point, line string or polygon\nCoordinates must be British National Grid easting and northing pairs\nEasting must be between 80000 and 656100 inclusive\nNorthing must be between 5000 and 657700 inclusive\nA point must contain only an easting and a northing"
					},
					"activity_name": {
						"type": "string",
						"description": "Max length 100 characters"
					},
					"activity_activity_type": {
						"$ref": "#/components/schemas/ActivityActivityType"
					},
					"activity_type_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if activity_activity_type is other\nMax length 100 characters\nValidated only when activity_activity_type is other"
					},
					"contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"contact_details": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Must be on the same date as start_date"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be on or after start_date"
					},
					"end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Must be after start_time when both fall on the same date"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Must contain at least one value\nArray values must be unique\nMust not include bus_stop_or_stand, cycle_hire_docking_station, parking_place or taxi_rank (reserved for HS2 works)"
					},
					"activity_location_description": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType"
					},
					"collaborative_working": {
						"type": "boolean"
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					}
				},
				"required": [
					"usrn",
					"activity_coordinates",
					"activity_name",
					"activity_activity_type",
					"start_date",
					"end_date",
					"location_types",
					"activity_location_description",
					"traffic_management_type",
					"collaborative_working"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityActivityTypeResponse": {
				"enum": [
					"skips",
					"scaffolding",
					"hoarding",
					"crane_mobile_platform",
					"event",
					"section50",
					"section58",
					"compound",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ActivityResponse": {
				"properties": {
					"activity_reference_number": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"street_name": {
						"type": "string",
						"nullable": true
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area_name": {
						"type": "string",
						"nullable": true
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true
					},
					"activity_coordinates": {},
					"activity_name": {
						"type": "string"
					},
					"activity_activity_type": {
						"$ref": "#/components/schemas/ActivityActivityTypeResponse"
					},
					"activity_activity_type_string": {
						"type": "string"
					},
					"activity_type_details": {
						"type": "string",
						"nullable": true
					},
					"contact_name": {
						"type": "string",
						"nullable": true
					},
					"contact_details": {
						"type": "string",
						"nullable": true
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					},
					"activity_location_description": {
						"type": "string"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"collaborative_working": {
						"type": "boolean"
					},
					"additional_info": {
						"type": "string",
						"nullable": true
					},
					"cancelled": {
						"type": "boolean"
					},
					"cancelled_reason": {
						"type": "string",
						"nullable": true
					},
					"highway_authority_swa_code": {
						"type": "string"
					}
				},
				"required": [
					"activity_reference_number",
					"usrn",
					"activity_coordinates",
					"activity_name",
					"activity_activity_type",
					"activity_activity_type_string",
					"start_date",
					"end_date",
					"location_types",
					"location_types_string",
					"activity_location_description",
					"traffic_management_type",
					"traffic_management_type_string",
					"collaborative_working",
					"cancelled",
					"highway_authority_swa_code"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityCancelRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"cancellation_reason": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					}
				},
				"type": "object",
				"additionalProperties": false
			},
			"ActivityUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"activity_name": {
						"type": "string",
						"description": "Max length 100 characters"
					},
					"activity_activity_type": {
						"$ref": "#/components/schemas/ActivityActivityType"
					},
					"activity_type_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if activity_activity_type is other\nMax length 100 characters\nValidated only when activity_activity_type is other"
					},
					"contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"contact_details": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Must be on the same date as start_date"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be on or after start_date"
					},
					"end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Must be on the same date as end_date\nMust be after start_time when both fall on the same date"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Must contain at least one value\nArray values must be unique\nMust not include bus_stop_or_stand, cycle_hire_docking_station, parking_place or taxi_rank (reserved for HS2 works)"
					},
					"activity_location_description": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType"
					},
					"collaborative_working": {
						"type": "boolean"
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					}
				},
				"required": [
					"activity_name",
					"activity_activity_type",
					"start_date",
					"end_date",
					"location_types",
					"activity_location_description",
					"traffic_management_type",
					"collaborative_working"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"forward_plan_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"forward_plan_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanWorkType": {
				"enum": [
					"planned",
					"hs2_highway_works"
				],
				"type": "string"
			},
			"ForwardPlanCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"work_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Max length 24 characters\nMust be unique in the system\nMust contain only alphanumeric characters, dashes and underscores\nIf not supplied it will be auto-generated"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be a date and time in the future\nMust be within 5 years of end_date"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be a date and time in the future\nMust be on or after start_date"
					},
					"description_of_work": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"traffic_management_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/TrafficManagementType"
							}
						],
						"nullable": true
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					},
					"forward_plan_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASD"
						},
						"type": "array",
						"nullable": true
					},
					"works_location_description": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"workstream_prefix": {
						"type": "string",
						"nullable": true,
						"description": "Must consist of 3 digits\nMust be the prefix of a workstream belonging to the promoter organisation"
					},
					"hs2_work_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ForwardPlanWorkType"
							}
						],
						"nullable": true,
						"description": "Required if the promoter organisation is HS2"
					},
					"hs2_in_act_limits": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if the promoter organisation is HS2"
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Validated only when the promoter organisation is HS2 and hs2_work_type is hs2_highway_works\nMust be today or a date in the future"
					},
					"hs2_highway_exemption": {
						"allOf": [
							{
								"$ref": "#/components/schemas/HS2HighwayExemption"
							}
						],
						"nullable": true,
						"description": "Required if the promoter organisation is HS2, hs2_work_type is hs2_highway_works and hs2_in_act_limits is true"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"start_date",
					"end_date",
					"description_of_work",
					"works_location_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanWorkTypeResponse": {
				"enum": [
					"planned",
					"hs2_highway_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ForwardPlanResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"forward_plan_reference_number": {
						"type": "string"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"forward_plan_status": {
						"$ref": "#/components/schemas/ForwardPlanStatusResponse"
					},
					"forward_plan_status_string": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_contact_details": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"highway_authority_swa_code": {
						"type": "string"
					},
					"workstream_prefix": {
						"type": "string"
					},
					"works_coordinates": {},
					"street_name": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area_name": {
						"type": "string",
						"nullable": true
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"road_category": {
						"type": "number",
						"format": "double"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"works_location_description": {
						"type": "string"
					},
					"description_of_work": {
						"type": "string"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true
					},
					"traffic_management_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/TrafficManagementTypeResponse"
							}
						],
						"nullable": true
					},
					"traffic_management_type_string": {
						"type": "string",
						"nullable": true
					},
					"additional_info": {
						"type": "string",
						"nullable": true
					},
					"forward_plan_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASDResponse"
						},
						"type": "array",
						"nullable": true
					},
					"cancelled_reason": {
						"type": "string",
						"nullable": true
					},
					"hs2_in_act_limits": {
						"type": "boolean",
						"nullable": true
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"hs2_highway_exemption": {
						"allOf": [
							{
								"$ref": "#/components/schemas/HS2HighwayExemptionResponse"
							}
						],
						"nullable": true
					},
					"hs2_highway_exemption_string": {
						"type": "string",
						"nullable": true
					},
					"hs2_works_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ForwardPlanWorkTypeResponse"
							}
						],
						"nullable": true
					},
					"hs2_works_type_string": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"work_reference_number",
					"forward_plan_reference_number",
					"start_date",
					"end_date",
					"forward_plan_status",
					"forward_plan_status_string",
					"promoter_organisation",
					"promoter_swa_code",
					"promoter_contact_details",
					"highway_authority",
					"highway_authority_swa_code",
					"workstream_prefix",
					"works_coordinates",
					"street_name",
					"usrn",
					"road_category",
					"date_created",
					"works_location_description",
					"description_of_work"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"works_coordinates": {
						"description": "Must be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be a date and time in the future\nMust be within 5 years of end_date"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Must be a date and time in the future\nMust be on or after start_date"
					},
					"works_location_description": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"description_of_work": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters"
					},
					"traffic_management_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/TrafficManagementType"
							}
						],
						"nullable": true
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					},
					"forward_plan_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASD"
						},
						"type": "array",
						"nullable": true,
						"description": "special_desig_location_text has a max length of 255 characters and special_desig_description a max length of 300 characters"
					}
				},
				"required": [
					"works_coordinates",
					"start_date",
					"end_date",
					"works_location_description",
					"description_of_work"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanCancelRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"cancelled_reason": {
						"type": "string",
						"description": "Max length 500 characters"
					}
				},
				"required": [
					"cancelled_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81CreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"section_81_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"section_81_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81Type": {
				"enum": [
					"tee_valve_access_covers",
					"cabinet",
					"marker_post",
					"pole_post",
					"overhead_cables_broken_low_encroaching_onto_highway",
					"other",
					"unattributed_works_live_site",
					"unattributed_works_completed"
				],
				"type": "string"
			},
			"Section81Severity": {
				"enum": [
					"high",
					"low"
				],
				"type": "string"
			},
			"Section81CreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nLocation types that only apply to HS2 works (bus stop or stand, cycle hire docking station, parking place, taxi rank) are not accepted"
					},
					"inspection_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate and time must be now or in the past"
					},
					"section_81_type": {
						"$ref": "#/components/schemas/Section81Type",
						"description": "Required"
					},
					"section_81_severity": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section81Severity"
							}
						],
						"nullable": true,
						"description": "Required if section_81_type is not unattributed_works_completed or unattributed_works_live_site\nIgnored for those two types"
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if section_81_type is not unattributed_works_completed or unattributed_works_live_site\nIgnored for those two types"
					},
					"inspector_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"inspector_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"other_type_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if section_81_type is other\nMax length 100 characters\nIgnored for any other section_81_type"
					},
					"reinspection_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must occur today or a date in the future\nIf provided, a follow-up inspection is scheduled for this date"
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date for reinspection_date_time must match the date for reinspection_date\nDate and time must be in the future"
					},
					"section_81_evidence": {
						"type": "boolean",
						"description": "Required\nSet to true if evidence files are being supplied, in which case file_ids is required"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if section_81_evidence = true\nMust contain between 1 and 50 values\nArray values must be unique\nMust not contain null or undefined values\nEach file_id must exist and can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"location_description",
					"location_types",
					"inspection_date",
					"section_81_type",
					"additional_details",
					"section_81_evidence"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81WorkTypeResponse": {
				"enum": [
					"permit_works",
					"non_notifiable_works",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LinkedPermit": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81Response": {
				"properties": {
					"section_81_reference_number": {
						"type": "string",
						"description": "Required\nAlways returned. Reference number of the Section 81."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways returned. Date and time the Section 81 was created."
					},
					"location_description": {
						"type": "string",
						"description": "Required\nAlways returned. In the single Section 81 response this is the location description entered on the Section 81; in the summary response it is that description followed by the street name and area."
					},
					"section_81_severity": {
						"$ref": "#/components/schemas/Section81SeverityResponse",
						"description": "Optional\nReturned only when section_81_type is not unattributed_works_completed or unattributed_works_live_site; omitted for those two types. A severity the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_severity_string": {
						"type": "string",
						"description": "Optional\nText form of section_81_severity; returned under the same conditions."
					},
					"section_81_status": {
						"$ref": "#/components/schemas/Section81StatusResponse",
						"description": "Required\nAlways returned. Current status of the Section 81. A status the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_status_string": {
						"type": "string",
						"description": "Required\nAlways returned. Text form of section_81_status."
					},
					"section_81_type": {
						"$ref": "#/components/schemas/Section81TypeResponse",
						"description": "Required\nAlways returned. A type the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_type_string": {
						"type": "string",
						"description": "Required\nAlways returned. Text form of section_81_type."
					},
					"work_reference_number": {
						"type": "string",
						"description": "Required\nAlways returned. Reference number of the works record for the Section 81."
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nAlways returned. USRN of the street the works are on."
					},
					"street_name": {
						"type": "string",
						"description": "Required\nAlways returned. Name of the street the works are on."
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value if the works have no town recorded."
					},
					"area": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value if the works have no area recorded."
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"description": "Required\nAlways returned. Road category of the street."
					},
					"works_coordinates": {
						"description": "Required\nAlways returned. Works coordinates as a GeoJSON geometry."
					},
					"highway_authority": {
						"type": "string",
						"description": "Required\nAlways returned. Name of the highway authority organisation."
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nAlways returned. SWA code of the highway authority organisation."
					},
					"promoter_organisation": {
						"type": "string",
						"description": "Required\nAlways returned. Name of the promoter organisation."
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nAlways returned. SWA code of the promoter organisation."
					},
					"workstream_prefix": {
						"type": "string",
						"description": "Required\nAlways returned. Prefix of the workstream the works belong to."
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nAlways returned. Location types recorded on the Section 81; an empty list if there are none."
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nAlways returned. Text form of location_types; an empty list if there are none."
					},
					"inspection_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways returned. Date and time of the inspection."
					},
					"other_type_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value unless other details were recorded for the type (the type is other)."
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"description": "Optional\nReturned only when section_81_type is not unattributed_works_completed or unattributed_works_live_site; omitted for those two types."
					},
					"inspector_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value if no inspector name was recorded."
					},
					"inspector_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value if no inspector contact number was recorded."
					},
					"additional_details": {
						"type": "string",
						"description": "Required\nAlways returned. Additional details recorded on the Section 81."
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways returned. Date and time the Section 81 status last changed."
					},
					"promoter_response": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value until the promoter has recorded a response."
					},
					"section_81_work_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section81WorkTypeResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nAlways returned; null until a work type has been recorded for the Section 81. A work type the API does not yet recognise is returned as upcoming_enum."
					},
					"section_81_work_type_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAlways returned; null until a work type has been recorded. Text form of section_81_work_type."
					},
					"promoter_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section81StatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nAlways returned; has no value until the promoter has set a status. A status the API does not yet recognise is returned as upcoming_enum."
					},
					"promoter_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nText form of promoter_status; has no value until the promoter has set a status."
					},
					"promoter_status_changed_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nAlways returned; has no value until the promoter has set a status."
					},
					"linked_permit": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LinkedPermit"
							}
						],
						"nullable": true,
						"description": "Optional\nReturned only when a permit is linked to the Section 81; omitted otherwise."
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nAlways returned, as an empty list when there are no files. Files are listed newest first."
					}
				},
				"required": [
					"section_81_reference_number",
					"date_created",
					"location_description",
					"section_81_status",
					"section_81_status_string",
					"work_reference_number",
					"usrn",
					"street_name",
					"road_category",
					"works_coordinates",
					"highway_authority",
					"highway_authority_swa_code",
					"promoter_organisation",
					"promoter_swa_code",
					"workstream_prefix",
					"location_types",
					"location_types_string",
					"inspection_date",
					"section_81_type",
					"section_81_type_string",
					"additional_details",
					"status_changed_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81Status": {
				"enum": [
					"issued",
					"acknowledged",
					"accepted",
					"accepted_fixed",
					"rejected",
					"resolved_by_ha",
					"cancelled",
					"reassigned"
				],
				"type": "string"
			},
			"Section81WorkType": {
				"enum": [
					"permit_works",
					"non_notifiable_works"
				],
				"type": "string"
			},
			"Section81StatusUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"section_81_status": {
						"$ref": "#/components/schemas/Section81Status",
						"description": "Required\nAllowed values: accepted, accepted_fixed, acknowledged, cancelled, rejected, resolved_by_ha\nHighway authority users can only use resolved_by_ha or cancelled; planners and contractors can only use acknowledged, accepted, accepted_fixed or rejected\nThe status must be a valid transition from the current status of the Section 81"
					},
					"status_reason": {
						"type": "string",
						"nullable": true,
						"description": "Required if section_81_status = rejected, accepted_fixed, resolved_by_ha or cancelled; otherwise Optional and ignored\nMax length 500 characters"
					},
					"work_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section81WorkType"
							}
						],
						"nullable": true,
						"description": "Required if section_81_status = accepted; otherwise Optional and ignored\nAllowed values: permit_works, non_notifiable_works\nPlanners and contractors accepting an unattributed works Section 81 must use permit_works"
					}
				},
				"required": [
					"section_81_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74CreateResponse": {
				"properties": {
					"section_74_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"section_74_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"OverrunWarningReason": {
				"enum": [
					"more_than_five_slg_items_left_on_site",
					"five_or_less_slg_items_left_on_site",
					"open_excavation",
					"spoil_left_on_site",
					"missing_road_markings",
					"missing_street_apparatus",
					"active_traffic_management"
				],
				"type": "string"
			},
			"Section74CreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"permit_reference_number": {
						"type": "string",
						"description": "Required\nMust be a permit on the work in the URL, otherwise the request is refused with 404 before any other validation"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nAt least one value\nArray values must be unique\nThe HS2-only location types (bus_stop_or_stand, cycle_hire_docking_station, parking_place, taxi_rank) are not accepted"
					},
					"inspection_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be the current time or a time in the past"
					},
					"overrun_warning_reasons": {
						"items": {
							"$ref": "#/components/schemas/OverrunWarningReason"
						},
						"type": "array",
						"description": "Required\nAt least one value\nArray values must be unique"
					},
					"overrun_warning_details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"officer_name": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"officer_contact_details": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"schedule_follow_up_inspection": {
						"type": "boolean",
						"description": "Required\nIf true, a follow-up inspection is scheduled and replaces any inspection already scheduled for the work"
					},
					"reinspection_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if schedule_follow_up_inspection = true, otherwise ignored\nDate must occur today or a date in the future"
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional (only considered if schedule_follow_up_inspection = true)\nThe date for reinspection_date_time must match the date for reinspection_date\nDate and time must be in the future"
					},
					"section_74_evidence": {
						"type": "boolean",
						"description": "Required\nIf true, file_ids must be supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if section_74_evidence = true, otherwise ignored\nMaximum 50 values\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					}
				},
				"required": [
					"permit_reference_number",
					"location_description",
					"location_types",
					"inspection_date",
					"overrun_warning_reasons",
					"overrun_warning_details",
					"officer_name",
					"officer_contact_details",
					"schedule_follow_up_inspection",
					"section_74_evidence"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74PromoterStatusResponse": {
				"enum": [
					"acknowledge_overrun_warning",
					"site_visited_and_rectified",
					"warning_disputed",
					"acknowledge_draft_invoice",
					"charge_under_review",
					"charge_agreed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section74Response": {
				"properties": {
					"permit_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the permit the Section 74 was issued against."
					},
					"section_74_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the Section 74, in the format {works reference number}-S74-{number}."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the Section 74 was created."
					},
					"overrun_warning_reasons": {
						"items": {
							"$ref": "#/components/schemas/OverrunWarningReasonResponse"
						},
						"type": "array",
						"description": "Required\nThe reasons the overrun warning was issued. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"overrun_warning_reasons_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nThe reasons the overrun warning was issued, as text."
					},
					"ha_status": {
						"$ref": "#/components/schemas/Section74HAStatusResponse",
						"description": "Required\nThe current highway authority status of the Section 74. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"ha_status_string": {
						"type": "string",
						"description": "Required\nThe current highway authority status of the Section 74, as text."
					},
					"location_description": {
						"type": "string",
						"description": "Required\nA description of the location of the overrun."
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nWhere on the street the overrun is. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nWhere on the street the overrun is, as text."
					},
					"inspection_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the site was inspected."
					},
					"overrun_warning_details": {
						"type": "string",
						"description": "Required\nFurther details about the overrun."
					},
					"officer_name": {
						"type": "string",
						"description": "Required\nThe name of the officer who issued the warning."
					},
					"officer_contact_details": {
						"type": "string",
						"description": "Required\nThe contact details of the officer who issued the warning."
					},
					"section_74_evidence": {
						"type": "boolean",
						"description": "Required\nWhether evidence files were supplied with the warning."
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nThe evidence files linked to the Section 74.\nReturned by the get Section 74 endpoint, as an empty list when there are no files."
					},
					"latest_ha_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time of the latest response by the highway authority.\nNull or omitted until the highway authority has responded."
					},
					"latest_promoter_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time of the latest response by the promoter.\nNull or omitted until the promoter has responded."
					},
					"latest_ha_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAdditional details entered by the highway authority with its latest response.\nPresent when ha_status is charges_ended. Also present when ha_status is draft_invoice_issued, resolved or withdrawn, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses."
					},
					"latest_promoter_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAdditional details entered by the promoter with its latest response.\nPresent when promoter_status is acknowledge_overrun_warning or site_visited_and_rectified. Also present when promoter_status is acknowledge_draft_invoice, charge_under_review or charge_agreed, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses."
					},
					"ha_reason_for_dispute": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe highway authority's reason for disputing the warning.\nPresent when ha_status is warning_disputed. Omitted for other statuses."
					},
					"promoter_reason_for_dispute": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe promoter's reason for disputing the warning.\nPresent when promoter_status is warning_disputed. Omitted for other statuses."
					},
					"site_visited_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time the promoter confirmed the site was visited and rectified.\nPresent when promoter_status is site_visited_and_rectified. Omitted for other statuses."
					},
					"site_cleared_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time the highway authority observed the site was clear.\nPresent when ha_status is charges_ended. Omitted for other statuses."
					},
					"ha_response_number_of_days_overrun": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nThe number of days the works overran.\nPresent when ha_status is draft_invoice_issued or resolved, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses and other users."
					},
					"draft_invoice_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reference of the draft invoice.\nPresent when ha_status is draft_invoice_issued, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses and other users. Null if no reference was supplied."
					},
					"invoice_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe reference of the final invoice.\nPresent when ha_status is resolved, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses and other users. Null if no reference was supplied."
					},
					"draft_invoice_amount": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nThe amount of the draft invoice.\nPresent when ha_status is draft_invoice_issued or resolved, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses and other users."
					},
					"final_agreed_amount": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nThe final amount agreed between the highway authority and the promoter.\nPresent when ha_status is resolved, but only for StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nOmitted for other statuses and other users."
					},
					"promoter_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section74PromoterStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe current promoter status of the Section 74.\nNull or omitted until the promoter has responded. A value the API does not yet recognise is returned as upcoming_enum."
					},
					"promoter_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe current promoter status of the Section 74, as text.\nNull or omitted until the promoter has responded."
					}
				},
				"required": [
					"permit_reference_number",
					"section_74_reference_number",
					"date_created",
					"overrun_warning_reasons",
					"overrun_warning_reasons_string",
					"ha_status",
					"ha_status_string",
					"location_description",
					"location_types",
					"location_types_string",
					"inspection_date",
					"overrun_warning_details",
					"officer_name",
					"officer_contact_details",
					"section_74_evidence"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74HAStatus": {
				"enum": [
					"warning_issued",
					"charges_ended",
					"warning_disputed",
					"withdrawn",
					"draft_invoice_issued",
					"resolved"
				],
				"type": "string"
			},
			"Section74UpdateHAStatusRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"status": {
						"$ref": "#/components/schemas/Section74HAStatus",
						"description": "Required\nCannot be warning_issued"
					},
					"site_cleared_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required when status is charges_ended, otherwise ignored\nMust be the current date and time or a date and time in the past"
					},
					"additional_details": {
						"type": "string",
						"description": "Required when status is withdrawn, otherwise optional\nMax length 500 characters\nOnly stored when status is charges_ended, draft_invoice_issued, resolved or withdrawn"
					},
					"number_of_days_overrun": {
						"type": "number",
						"format": "double",
						"description": "Required when status is draft_invoice_issued or resolved, otherwise ignored\nMust be a positive whole number"
					},
					"draft_invoice_amount": {
						"type": "number",
						"format": "double",
						"description": "Required when status is draft_invoice_issued, otherwise ignored\nMust be greater than 0 and no more than 999999.99\nCan contain decimals to two decimal places"
					},
					"draft_invoice_reference": {
						"type": "string",
						"description": "Optional\nMax length 100 characters\nOnly stored when status is draft_invoice_issued"
					},
					"final_agreed_amount": {
						"type": "number",
						"format": "double",
						"description": "Required when status is resolved, otherwise ignored\nMust be between 0 and 999999.99\nCan contain decimals to two decimal places"
					},
					"invoice_reference": {
						"type": "string",
						"description": "Optional\nMax length 100 characters\nOnly stored when status is resolved"
					},
					"reason_for_dispute": {
						"type": "string",
						"description": "Required when status is warning_disputed, otherwise ignored\nMax length 500 characters"
					}
				},
				"required": [
					"status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74PromoterStatus": {
				"enum": [
					"acknowledge_overrun_warning",
					"site_visited_and_rectified",
					"warning_disputed",
					"acknowledge_draft_invoice",
					"charge_under_review",
					"charge_agreed"
				],
				"type": "string"
			},
			"Section74UpdatePromoterStatusRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"status": {
						"$ref": "#/components/schemas/Section74PromoterStatus",
						"description": "Required\nThe new promoter status. Which current promoter and highway authority statuses allow each new status is described in the endpoint business rules"
					},
					"site_visited_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required if status is site_visited_and_rectified, otherwise not validated and not used\nMust be a valid date and time that is now or in the past"
					},
					"additional_details": {
						"type": "string",
						"description": "Optional\nMax length 500 characters\nUsed for every status except warning_disputed (not used for that status)"
					},
					"reason_for_dispute": {
						"type": "string",
						"description": "Required if status is warning_disputed, otherwise not validated and not used\nMax length 500 characters"
					}
				},
				"required": [
					"status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FinalReinstatementUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"final_reinstatement": {
						"type": "boolean",
						"description": "Required\nWhether the final site has been registered for the works. Can be true or false.\nThe works must have at least one excavation site, otherwise the request is rejected"
					}
				},
				"required": [
					"final_reinstatement"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HistoricFPNCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"fpn_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"fpn_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HistoricFPNCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"historical_permit_reference": {
						"type": "string",
						"description": "Required\nMax length 24 characters\nMust be unique in the system, this will become the work_reference_number\nMust contain only alphanumeric characters, dashes and underscores"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"description_of_work": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"work_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must be in the past"
					},
					"work_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must be in the past\nMust be on or after work_start_date"
					},
					"fpn_evidence": {
						"type": "boolean",
						"description": "Required\nWhether FPN evidence has been supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if fpn_evidence is true\nMust contain between 1 and 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"offence_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\noffence_date must be now or in the past"
					},
					"offence_code": {
						"$ref": "#/components/schemas/OffenceCode",
						"description": "Required"
					},
					"offence_details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"authorised_officer": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"officer_contact_details": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"officer_address": {
						"type": "string",
						"description": "Required"
					},
					"representations_contact": {
						"type": "string",
						"description": "Required"
					},
					"representations_contact_address": {
						"type": "string",
						"description": "Required"
					},
					"payment_methods": {
						"items": {
							"$ref": "#/components/schemas/PaymentMethod"
						},
						"type": "array",
						"description": "Required"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"historical_permit_reference",
					"works_location_description",
					"fpn_evidence",
					"offence_date",
					"offence_code",
					"offence_details",
					"authorised_officer",
					"officer_contact_details",
					"officer_address",
					"representations_contact",
					"representations_contact_address",
					"payment_methods"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonNotifiableSiteCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"site_reference_number": {
						"type": "string",
						"description": "Required\nGenerated as the works reference number followed by -S and the site number, for example ABC123-S1"
					},
					"reinstatement_reference_number": {
						"type": "string",
						"description": "Required\nGenerated as the site reference number followed by -R and the reinstatement number, for example ABC123-S1-R1"
					}
				},
				"required": [
					"work_reference_number",
					"site_reference_number",
					"reinstatement_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonNotifiableSiteCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"work_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMust be unique in the system\nIf not supplied it will be auto-generated\nThe supplied value is stored in upper case"
					},
					"workstream_prefix": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMust consist of 3 positive whole numbers\nMust be an existing workstream of the promoter\nThe default workstream cannot be used"
					},
					"reinstatement_type": {
						"$ref": "#/components/schemas/ReinstatementType",
						"description": "Required\nExcavation reinstatements are not accepted"
					},
					"reinstatement_status": {
						"$ref": "#/components/schemas/ReinstatementStatus",
						"description": "Required"
					},
					"reinstatement_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be now or in the past"
					},
					"reinstatement_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nA point must contain a single coordinate pair"
					},
					"secondary_reinstatement_coordinates": {
						"nullable": true,
						"description": "Optional\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon, if provided\nA point must contain a single coordinate pair"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nHS2 location types cannot be used"
					},
					"reinstatement_evidence": {
						"type": "boolean",
						"description": "Required\nWhether reinstatement evidence has been supplied"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nRequired if reinstatement_evidence is true\nMust contain between 1 and 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"number_of_holes": {
						"type": "number",
						"format": "double",
						"description": "Required\nMust be a whole number between 0 and 100 inclusive"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"reinstatement_type",
					"reinstatement_status",
					"reinstatement_date",
					"reinstatement_coordinates",
					"location_description",
					"location_types",
					"reinstatement_evidence",
					"number_of_holes"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HistoricInspectionCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"inspection_reference_number": {
						"type": "string"
					},
					"non_compliance_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"inspection_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HistoricFailureReasonDetails": {
				"properties": {
					"failure_reason": {
						"$ref": "#/components/schemas/FailureReason",
						"description": "Required\nMust be a failure reason that is valid for the inspection type\nSee business rules section 4.1.3 - Inspection outcomes"
					},
					"site_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if the inspection type is reinstatement, non_compliance_follow_up or investigatory_works\nMax length 100 characters"
					},
					"details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"failure_reason",
					"details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"HistoricInspectionCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"historical_permit_reference": {
						"type": "string",
						"description": "Required\nMax length 24 characters\nMust be unique in the system, this will become the work_reference_number\nMust contain only alphanumeric characters, dashes and underscores"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"description_of_work": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"work_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must be in the past"
					},
					"work_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must be in the past\nMust be on or after work_start_date"
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionType",
						"description": "Required\nSee business rules section 4.1.2 - Inspection types and categories"
					},
					"inspection_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate and time must not be in the future"
					},
					"inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategory"
							}
						],
						"nullable": true,
						"description": "Required unless inspection_type is section_81\nMust be a valid category for the inspection_type:\nlive_site - site_occupancy, conditions, third_party or routine\nreinstatement - third_party or routine\nnon_compliance_follow_up - joint_site_visit, follow_up or follow_up_completion\nSee business rules section 4.1.2 - Inspection types and categories"
					},
					"inspection_outcome": {
						"$ref": "#/components/schemas/InspectionOutcome",
						"description": "Required\nMust be a valid outcome for the inspection_category:\nsite_occupancy - works_stopped, works_stopped_apparatus_remaining, works_in_progress, works_in_progress_no_carriageway_incursion or unable_to_complete_inspection\nconditions - passed, non_compliant_with_conditions or unable_to_complete_inspection\njoint_site_visit - further_inspections_required, agreed_site_compliance or unable_to_complete_inspection\ncore_sample, skid_resistance, texture_depth, surface_regularity or trial_hole - passed, failed or unable_to_complete_inspection\nall other categories, and section_81 - passed, failed_high, failed_low or unable_to_complete_inspection\nSee business rules section 4.1.3 - Inspection outcomes"
					},
					"failure_reason_details": {
						"items": {
							"$ref": "#/components/schemas/HistoricFailureReasonDetails"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if the outcome is failed, failed_high or failed_low and inspection_type is not section_81\nMust contain at least one item\nEach failure_reason must be unique\nSee business rules section 4.1.3 - Inspection outcomes"
					},
					"inspection_outcome_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if inspection_outcome is unable_to_complete_inspection or non_compliant_with_conditions\nMax length 500 characters"
					},
					"was_call_logged": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if inspection_outcome is failed_high, inspection_type is live_site and defect_fixed_on_site is no\nOtherwise ignored"
					},
					"call_logged_to": {
						"type": "string",
						"nullable": true,
						"description": "Required if was_call_logged is true\nMax length 100 characters"
					},
					"call_logged_reference": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly applies if was_call_logged is true\nMax length 100 characters"
					},
					"call_logged_summary": {
						"type": "string",
						"nullable": true,
						"description": "Required if was_call_logged is true\nMax length 500 characters"
					},
					"defect_fixed_on_site": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DefectFixedOnsite"
							}
						],
						"nullable": true,
						"description": "Required if inspection_outcome is failed_high and inspection_type is live_site\nMust be yes_by_inspector, yes_by_onsite_members or no"
					},
					"additional_comments": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"inspection_evidence": {
						"type": "boolean",
						"description": "Required\nSet to true if you are providing evidence files in file_ids"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if inspection_evidence is true\nMust contain between 1 and 50 file ids\nArray values must be unique\nMust not contain null or undefined values\nEvery file must already have been uploaded and must not already be associated with another record\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"reinspection_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nDate must be today or a date in the future\nIf provided, a follow-up scheduled inspection is created against the works"
					},
					"reinspection_date_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date must match the date for reinspection_date\nMust be in the future"
					},
					"reinspection_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionType"
							}
						],
						"nullable": true,
						"description": "Optional\nDefaulted to the inspection_type if this and/or reinspection_category are not provided and reinspection_date is provided"
					},
					"reinspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategory"
							}
						],
						"nullable": true,
						"description": "Optional\nMust be a valid category for the reinspection_type:\nlive_site - site_occupancy, conditions, third_party or routine\nreinstatement - third_party or routine\nnon_compliance_follow_up - joint_site_visit, follow_up or follow_up_completion\nDefaulted to the inspection_category if this and/or reinspection_type are not provided and reinspection_date is provided\nSee business rules section 4.1.2 - Inspection types and categories"
					},
					"username": {
						"type": "string",
						"description": "Required\nMax length 100 characters\nShould be populated with the user creating the inspection"
					},
					"inspector_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if inspection_type is section_81 and inspection_outcome is failed_high or failed_low\nOtherwise ignored"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"historical_permit_reference",
					"works_location_description",
					"inspection_type",
					"inspection_start_date",
					"inspection_outcome",
					"inspection_evidence",
					"username"
				],
				"type": "object",
				"additionalProperties": false
			},
			"GeographicalAreaCreateResponse": {
				"properties": {
					"file_id": {
						"type": "number",
						"format": "double"
					},
					"geographical_area_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"file_id",
					"geographical_area_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ExcavationCarriedOutUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"excavation_carried_out": {
						"type": "boolean",
						"description": "Required\nWhether an excavation was actually carried out. Must be a boolean.\nCan only be updated if excavation was requested in the active permit (or already marked as carried out) and the works are in progress or completed\nOnce an excavation reinstatement has been added this field can no longer be updated"
					}
				},
				"required": [
					"excavation_carried_out"
				],
				"type": "object",
				"additionalProperties": false
			},
			"LinkSection81ToPermitResponse": {
				"properties": {
					"section_81_work_reference_number": {
						"type": "string"
					},
					"section_81_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"section_81_work_reference_number",
					"section_81_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"LinkSection81ToPermitRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"section_81_reference_number": {
						"type": "string",
						"description": "Required\nMust not be empty. Max length 28 characters\nThe reference number is matched case-insensitively"
					}
				},
				"required": [
					"section_81_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"UnlinkSection81FromPermitRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"section_81_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the Section 81 (or Unattributed work) to unlink from the permit. Matched case-insensitively\nMax length 28 characters\nMust currently be linked to the permit in the URL"
					},
					"unlink_reason": {
						"type": "string",
						"description": "Required\nReason for removing the link. Recorded in the audit events of both the permit and the Section 81\nMax length 500 characters"
					}
				},
				"required": [
					"section_81_reference_number",
					"unlink_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReassignSection81Response": {
				"properties": {
					"section_81_reference_number": {
						"type": "string",
						"description": "Reference number of the new Section 81 created for the new organisation"
					},
					"work_reference_number": {
						"type": "string",
						"description": "Reference number of the new works record created for the new organisation"
					}
				},
				"required": [
					"section_81_reference_number",
					"work_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReassignSection81Request": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"new_organisation_reference": {
						"type": "string",
						"description": "Required, max length 4 characters. Reference of the organisation to reassign the Section 81 to. Must be an existing organisation that is not disabled and different from the current promoter of the Section 81"
					}
				},
				"required": [
					"new_organisation_reference"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58CreateResponse": {
				"properties": {
					"section_58_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"section_58_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58Duration": {
				"enum": [
					"six_months",
					"one_year",
					"two_years",
					"three_years"
				],
				"type": "string"
			},
			"Section58Extent": {
				"enum": [
					"whole_road",
					"part_of_the_road"
				],
				"type": "string"
			},
			"Section58CreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"section_58_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a line string or polygon\nEach coordinate must be within UK British National Grid bounds: easting 80000 to 656100, northing 5000 to 657700"
					},
					"contact_organisation": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"contact_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate must occur today or a date in the future\nThe restriction end date is calculated from this date and restriction_duration (one day before the anniversary)"
					},
					"restriction_duration": {
						"$ref": "#/components/schemas/Section58Duration",
						"description": "Required"
					},
					"restriction_extent": {
						"$ref": "#/components/schemas/Section58Extent",
						"description": "Required"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique\nparking_place, bus_stop_or_stand, cycle_hire_docking_station and taxi_rank are not accepted by this endpoint"
					},
					"additional_information": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 500 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters\nMust be the SWA code of your organisation or an organisation you have access to"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					}
				},
				"required": [
					"section_58_coordinates",
					"start_date",
					"restriction_duration",
					"restriction_extent",
					"location_types",
					"highway_authority_swa_code",
					"usrn"
				],
				"type": "object",
				"additionalProperties": false
			},
			"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"
			},
			"Section58Response": {
				"properties": {
					"section_58_reference_number": {
						"type": "string",
						"description": "Required\nAlways present. The reference number of the Section 58"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nAlways present. The USRN of the street"
					},
					"street_name": {
						"type": "string",
						"description": "Required\nAlways present. The street name recorded when the Section 58 was created"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent as null when no town was recorded for the Section 58"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent as null when no area name was recorded for the Section 58"
					},
					"section_58_coordinates": {
						"description": "Required\nAlways present. The affected area as GeoJSON (line string or polygon)"
					},
					"contact_organisation": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent as null when no contact organisation was supplied"
					},
					"contact_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent as null when no contact details were supplied"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways present. The restriction start date"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways present. The restriction end date"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nAlways present. The location types the restriction applies to"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nAlways present. The same location types as location_types, as strings"
					},
					"additional_information": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent as null when no additional information was supplied"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nAlways present. The SWA code of the highway authority that raised the Section 58, left-padded with zeros to 4 characters"
					},
					"status_change_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nAlways present. The date the status last changed"
					},
					"section_58_status": {
						"$ref": "#/components/schemas/Section58StatusResponse",
						"description": "Required\nAlways present. The current status of the Section 58"
					},
					"section_58_status_string": {
						"type": "string",
						"description": "Required\nAlways present. The current status of the Section 58, as a string"
					},
					"restriction_duration": {
						"$ref": "#/components/schemas/Section58DurationResponse",
						"description": "Required\nAlways present. The restriction duration"
					},
					"restriction_duration_string": {
						"type": "string",
						"description": "Required\nAlways present. The restriction duration, as a string"
					},
					"restriction_extent": {
						"$ref": "#/components/schemas/Section58ExtentResponse",
						"description": "Required\nAlways present. The restriction extent"
					},
					"restriction_extent_string": {
						"type": "string",
						"description": "Required\nAlways present. The restriction extent, as a string"
					},
					"cancellation_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly populated when section_58_status is cancelled (may still be null if no reason was recorded). Not populated for any other status"
					}
				},
				"required": [
					"section_58_reference_number",
					"usrn",
					"street_name",
					"section_58_coordinates",
					"start_date",
					"end_date",
					"location_types",
					"location_types_string",
					"highway_authority_swa_code",
					"status_change_date",
					"section_58_status",
					"section_58_status_string",
					"restriction_duration",
					"restriction_duration_string",
					"restriction_extent",
					"restriction_extent_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58Status": {
				"enum": [
					"proposed",
					"in_force",
					"cancelled",
					"closed"
				],
				"type": "string"
			},
			"Section58UpdateStatusRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"status": {
						"$ref": "#/components/schemas/Section58Status",
						"description": "Required\nMust be in_force or cancelled; proposed and closed are rejected"
					},
					"start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required when status is in_force, otherwise ignored\nMust be a valid date\nSets the restriction start date; the end date is recalculated from the Section 58's restriction duration"
					},
					"cancellation_reason": {
						"type": "string",
						"nullable": true,
						"description": "Optional, only used when status is cancelled (ignored otherwise)\nMax length 500 characters"
					}
				},
				"required": [
					"status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FeeMatrixRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"major_paa_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"major_work_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"standard_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"minor_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"immediate_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"permit_variation_fee_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"major_paa_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"major_work_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"standard_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"minor_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"immediate_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"permit_variation_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double",
						"description": "Must be between 0 and 999999.99 with a maximum of 2 decimal places"
					},
					"discount_guidance": {
						"type": "string",
						"description": "Max length 500 characters\nMust not be an empty string"
					},
					"charge_band_one_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 1 cost\nValidated when either charge_band_one_cost or charge_band_one_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_one_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_one_cost to be provided"
					},
					"charge_band_two_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 2 cost\nValidated when either charge_band_two_cost or charge_band_two_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_two_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_two_cost to be provided"
					},
					"charge_band_three_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 3 cost\nValidated when either charge_band_three_cost or charge_band_three_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_three_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_three_cost to be provided"
					},
					"charge_band_four_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 4 cost\nValidated when either charge_band_four_cost or charge_band_four_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_four_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_four_cost to be provided"
					},
					"charge_band_five_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 5 cost\nValidated when either charge_band_five_cost or charge_band_five_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_five_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_five_cost to be provided"
					},
					"charge_band_six_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 6 cost\nValidated when either charge_band_six_cost or charge_band_six_description is provided\nWhen validated, must be between 0 and 999999.99 with a maximum of 2 decimal places and must not be null"
					},
					"charge_band_six_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 100 characters\nProviding this requires charge_band_six_cost to be provided"
					},
					"lane_rental_discount_guidance": {
						"type": "string",
						"nullable": true,
						"description": "Max length 500 characters"
					},
					"lane_rental_guidance_link": {
						"type": "string",
						"nullable": true,
						"description": "Max length 2048 characters\nMust be a valid URL using the https protocol\nValidated only when provided and not an empty string; an empty string is stored as no link"
					}
				},
				"required": [
					"major_paa_fee_traffic_sensitive",
					"major_work_permit_fee_traffic_sensitive",
					"standard_works_permit_fee_traffic_sensitive",
					"minor_works_permit_fee_traffic_sensitive",
					"immediate_works_permit_fee_traffic_sensitive",
					"permit_variation_fee_traffic_sensitive",
					"major_paa_fee_non_traffic_sensitive",
					"major_work_permit_fee_non_traffic_sensitive",
					"standard_works_permit_fee_non_traffic_sensitive",
					"minor_works_permit_fee_non_traffic_sensitive",
					"immediate_works_permit_fee_non_traffic_sensitive",
					"permit_variation_fee_non_traffic_sensitive",
					"discount_guidance"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FeeMatrixResponse": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"major_paa_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"major_work_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"standard_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"minor_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"immediate_works_permit_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"permit_variation_fee_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"major_paa_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"major_work_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"standard_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"minor_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"immediate_works_permit_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"permit_variation_fee_non_traffic_sensitive": {
						"type": "number",
						"format": "double"
					},
					"discount_guidance": {
						"type": "string"
					},
					"charge_band_one_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 1 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_one_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"charge_band_two_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 2 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_two_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"charge_band_three_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 3 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_three_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"charge_band_four_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 4 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_four_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"charge_band_five_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 5 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_five_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"charge_band_six_cost": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Lane rental charge band 6 cost. Omitted from the response if the authority has not set a cost for this band"
					},
					"charge_band_six_description": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not set a description for this band"
					},
					"lane_rental_discount_guidance": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not provided lane rental discount guidance"
					},
					"lane_rental_guidance_link": {
						"type": "string",
						"nullable": true,
						"description": "Omitted from the response if the authority has not provided a lane rental guidance link"
					}
				},
				"required": [
					"major_paa_fee_traffic_sensitive",
					"major_work_permit_fee_traffic_sensitive",
					"standard_works_permit_fee_traffic_sensitive",
					"minor_works_permit_fee_traffic_sensitive",
					"immediate_works_permit_fee_traffic_sensitive",
					"permit_variation_fee_traffic_sensitive",
					"major_paa_fee_non_traffic_sensitive",
					"major_work_permit_fee_non_traffic_sensitive",
					"standard_works_permit_fee_non_traffic_sensitive",
					"minor_works_permit_fee_non_traffic_sensitive",
					"immediate_works_permit_fee_non_traffic_sensitive",
					"permit_variation_fee_non_traffic_sensitive",
					"discount_guidance"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CreateAncillaryInfoResponse": {
				"properties": {
					"ancillary_info_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"ancillary_info_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AncillaryInfoType": {
				"enum": [
					"portable_traffic_signals_or_other_traffic_controls",
					"site_welfare_facilities",
					"site_compound_or_material_storage",
					"site_compound_for_works"
				],
				"type": "string"
			},
			"CreateAncillaryInfoRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"location_description": {
						"type": "string",
						"nullable": true,
						"description": "Required unless ancillary_info_type is portable_traffic_signals_or_other_traffic_controls\nMax length 500 characters"
					},
					"ancillary_info_description": {
						"type": "string",
						"description": "Max length 500 characters"
					},
					"ancillary_info_coordinates": {
						"items": {},
						"type": "array",
						"description": "Must contain at least one point and no more than 10\nEach value must be a GeoJSON Point geometry using a British National Grid easting and northing coordinate pair, with easting between 80000 and 656100 and northing between 5000 and 657700\nPoints must be unique"
					},
					"usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"description": "Must contain at least one USRN and no more than 25\nValues must be unique\nSee business rules section 1.4 - USRN"
					},
					"ancillary_info_type": {
						"$ref": "#/components/schemas/AncillaryInfoType"
					}
				},
				"required": [
					"ancillary_info_description",
					"ancillary_info_coordinates",
					"usrns",
					"ancillary_info_type"
				],
				"type": "object",
				"additionalProperties": false
			},
			"RemoveAncillaryInfoResponse": {
				"properties": {
					"ancillary_info_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"ancillary_info_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"RemoveAncillaryInfoRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"ancillary_info_removal_reason": {
						"type": "string",
						"description": "Max length 500 characters"
					}
				},
				"required": [
					"ancillary_info_removal_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AncillaryInfoResponse": {
				"properties": {
					"ancillary_info_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string",
						"nullable": true
					},
					"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"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"date_removed": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"ancillary_info_description": {
						"type": "string"
					},
					"ancillary_info_removal_reason": {
						"type": "string",
						"nullable": true
					},
					"ancillary_info_coordinates": {
						"items": {},
						"type": "array"
					},
					"usrns": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array"
					}
				},
				"required": [
					"ancillary_info_reference_number",
					"ancillary_info_type",
					"ancillary_info_status",
					"ancillary_info_type_string",
					"ancillary_info_status_string",
					"date_created",
					"ancillary_info_description",
					"ancillary_info_coordinates",
					"usrns"
				],
				"type": "object",
				"additionalProperties": false
			},
			"JsmStatusResponse": {
				"enum": [
					"awaiting_agreement",
					"date_and_time_agreed",
					"jsm_not_needed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"NonComplianceResponseStatusResponse": {
				"enum": [
					"issued",
					"withdrawn",
					"works_completed_and_passed",
					"joint_site_meeting_suggested",
					"will_attend_joint_site_meeting",
					"works_complete_ready_for_inspection",
					"joint_site_meeting_not_needed",
					"accept_suggestion",
					"upcoming_enum"
				],
				"type": "string"
			},
			"NonComplianceResponse": {
				"properties": {
					"non_compliance_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the non-compliance."
					},
					"work_reference_number": {
						"type": "string",
						"description": "Required\nThe reference number of the works the non-compliance belongs to."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe date and time the non-compliance was created."
					},
					"non_compliance_status": {
						"$ref": "#/components/schemas/NonComplianceStatusResponse",
						"description": "Required\nThe overall status of the non-compliance."
					},
					"non_compliance_status_string": {
						"type": "string",
						"description": "Required\nThe overall status of the non-compliance as a string."
					},
					"jsm_requested_by": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe name of the organisation that requested the joint site meeting. Only returned when a joint site meeting status has been set."
					},
					"jsm_suggested_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe suggested date and time of the joint site meeting. Only returned when a joint site meeting status has been set."
					},
					"jsm_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/JsmStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe status of the joint site meeting. Only returned when a joint site meeting status has been set."
					},
					"jsm_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe status of the joint site meeting as a string. Only returned when a joint site meeting status has been set."
					},
					"promoter_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/NonComplianceResponseStatusResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe latest response status from the promoter. Only returned when the promoter has responded."
					},
					"promoter_response_status_string": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe latest response status from the promoter as a string. Only returned when the promoter has responded."
					},
					"promoter_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time of the promoter's latest response. Only returned when the promoter has responded."
					},
					"promoter_response_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAdditional details provided by the promoter with their response. Only returned when details were provided."
					},
					"promoter_response_jsm_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe joint site meeting date provided by the promoter with their response. Only returned when a date was provided."
					},
					"ha_response_status": {
						"$ref": "#/components/schemas/NonComplianceResponseStatusResponse",
						"description": "Required\nThe latest response status from the highway authority."
					},
					"ha_response_status_string": {
						"type": "string",
						"description": "Required\nThe latest response status from the highway authority as a string."
					},
					"ha_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe date and time of the highway authority's latest response. Only returned when it has been set."
					},
					"ha_response_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nAdditional details provided by the highway authority with their response. Only returned when details were provided."
					},
					"ha_response_jsm_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe joint site meeting date provided by the highway authority with their response. Only returned when a date was provided."
					},
					"latest_inspection": {
						"$ref": "#/components/schemas/InspectionResponse",
						"description": "Required\nThe most recently created inspection linked to the non-compliance."
					},
					"linked_inspections": {
						"items": {
							"$ref": "#/components/schemas/InspectionSummaryResponse"
						},
						"type": "array",
						"description": "Required\nSummaries of all inspections linked to the non-compliance, most recently created first."
					},
					"linked_permits": {
						"items": {
							"$ref": "#/components/schemas/PermitSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nSummaries of the permits linked to the non-compliance. Only returned when at least one permit is linked."
					}
				},
				"required": [
					"non_compliance_reference_number",
					"work_reference_number",
					"date_created",
					"non_compliance_status",
					"non_compliance_status_string",
					"ha_response_status",
					"ha_response_status_string",
					"latest_inspection",
					"linked_inspections"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonComplianceResponseStatus": {
				"enum": [
					"issued",
					"withdrawn",
					"works_completed_and_passed",
					"joint_site_meeting_suggested",
					"will_attend_joint_site_meeting",
					"works_complete_ready_for_inspection",
					"joint_site_meeting_not_needed",
					"accept_suggestion"
				],
				"type": "string"
			},
			"NonComplianceResponseStatusRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"non_compliance_response_status": {
						"$ref": "#/components/schemas/NonComplianceResponseStatus",
						"description": "Required\nThe response being recorded. Allowed values depend on the user's role:\n- Highway Authority: withdrawn, joint_site_meeting_suggested, will_attend_joint_site_meeting, accept_suggestion\n- Planner or Contractor: joint_site_meeting_suggested, will_attend_joint_site_meeting, accept_suggestion, works_complete_ready_for_inspection, joint_site_meeting_not_needed"
					},
					"response_details": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nRequired when the response is withdrawn or joint_site_meeting_not_needed. Max length 500 characters"
					},
					"jsm_suggested_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nRequired when the response is joint_site_meeting_suggested; ignored otherwise. Must be today or in the future"
					}
				},
				"required": [
					"non_compliance_response_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetNoticeCreateResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"private_street_reference_number": {
						"type": "string",
						"description": "The reference number of the private street notice, made of the works reference number followed by -PSN"
					}
				},
				"required": [
					"work_reference_number",
					"private_street_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetNoticeCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters"
					},
					"works_coordinates": {
						"description": "Required\nMust be a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and must be a point, line string or polygon\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nSee business rules section 1.4 - USRN"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional\nIs whole number between 1 and 10 inclusive\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"work_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 24 characters\nMust be unique in the system\nMust contain only alphanumeric characters, dashes and underscores\nStored in upper case\nIf not supplied it will be auto-generated"
					},
					"secondary_contact": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_number": {
						"type": "string",
						"description": "Required\nMax length 100 characters"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be a valid date"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nRequired if proposed_start_date is in the past\nMust be on the same date as proposed_start_date"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be a valid date\nMust be on or after proposed_start_date"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nRequired if proposed_end_date is in the past\nMust be on the same date as proposed_end_date\nMust be after proposed_start_time if proposed_end_date is the same date as proposed_start_date"
					},
					"description_of_work": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"excavation": {
						"type": "boolean",
						"description": "Required\nWhether an excavation will be required"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"traffic_management_plan": {
						"type": "boolean",
						"description": "Required\nWhether a traffic management plan is in place"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType",
						"description": "Required\nemergency_contact_name and emergency_contact_number are also required if this is 'multi_way_signals' or 'two_way_signals'"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nArray values must be unique\nArray max length 50 items\nMust not contain null or undefined values\nEvery file_id must exist\nA file_id can only be associated with one section of Street Manager"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootway",
						"description": "Required"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpath",
						"description": "Required"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"workstream_prefix": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMust be the prefix of an existing workstream of the promoter organisation\nYou must have write access to the workstream\nThe default workstream (000) cannot be used\nIf not supplied, the first workstream you have write access to is used"
					},
					"additional_contact": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters"
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nRequired if traffic_management_type = 'multi_way_signals' or 'two_way_signals'"
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nMax length 100 characters\nRequired if traffic_management_type = 'multi_way_signals' or 'two_way_signals'"
					}
				},
				"required": [
					"promoter_swa_code",
					"highway_authority_swa_code",
					"works_coordinates",
					"usrn",
					"secondary_contact",
					"secondary_contact_number",
					"proposed_start_date",
					"proposed_end_date",
					"description_of_work",
					"excavation",
					"traffic_management_plan",
					"traffic_management_type",
					"location_types",
					"close_footway",
					"close_footpath",
					"works_location_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetNoticeResponse": {
				"properties": {
					"private_street_reference_number": {
						"type": "string",
						"description": "Required\nThe private street notice reference number, i.e. the works reference number followed by -PSN"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed start date"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nThe proposed end date"
					},
					"private_street_status": {
						"$ref": "#/components/schemas/PrivateStreetStatusResponse",
						"description": "Required\nThe status of the notice: 'issued' or 'cancelled'"
					},
					"private_street_status_string": {
						"type": "string",
						"description": "Required\nThe status of the notice as a string"
					},
					"work_reference_number": {
						"type": "string",
						"description": "Required\nThe works reference number"
					},
					"promoter_organisation": {
						"type": "string",
						"description": "Required\nThe name of the promoter organisation"
					},
					"promoter_swa_code": {
						"type": "string",
						"description": "Required\nThe SWA code of the promoter organisation, padded to 4 characters"
					},
					"secondary_contact": {
						"type": "string",
						"description": "Required\nThe name of the secondary contact"
					},
					"secondary_contact_number": {
						"type": "string",
						"description": "Required\nThe telephone number of the secondary contact"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe email address of the secondary contact"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe proposed start time, only present if one was supplied when the notice was created"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional\nThe proposed end time, only present if one was supplied when the notice was created"
					},
					"calendar_day_duration": {
						"type": "number",
						"format": "double",
						"description": "Required\nThe calendar day duration of the works"
					},
					"working_day_duration": {
						"type": "number",
						"format": "double",
						"description": "Required\nThe working day duration of the works"
					},
					"description_of_work": {
						"type": "string",
						"description": "Required\nA description of the works"
					},
					"excavation": {
						"type": "boolean",
						"description": "Required\nWhether an excavation is required"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe project reference number"
					},
					"street_name": {
						"type": "string",
						"description": "Required\nThe street name held on the works record"
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe town held on the works record"
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe area name held on the works record"
					},
					"usrn": {
						"type": "string",
						"description": "Required\nThe USRN of the street, as a string"
					},
					"highway_authority": {
						"type": "string",
						"description": "Required\nThe name of the highway authority"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nThe SWA code of the highway authority, padded to 4 characters"
					},
					"works_location_description": {
						"type": "string",
						"description": "Required\nA description of the location of the works"
					},
					"works_coordinates": {
						"description": "Required\nThe location of the works as GeoJSON"
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nWhen the notice was created"
					},
					"date_modified": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nWhen the notice was last modified"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse",
						"description": "Required\nThe type of traffic management"
					},
					"traffic_management_type_string": {
						"type": "string",
						"description": "Required\nThe type of traffic management as a string"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nThe location types of the works"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nThe location types of the works as strings"
					},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nThe files attached to the notice, an empty array if there are none"
					},
					"workstream_prefix": {
						"type": "string",
						"description": "Required\nThe prefix of the workstream the works belong to"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootwayResponse",
						"description": "Required\nWhether the footway is closed, returned as 'no' if no value is stored"
					},
					"close_footway_string": {
						"type": "string",
						"description": "Required\nWhether the footway is closed as a string, returned as 'no' if no value is stored"
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse",
						"description": "Required\nThe status of the works record"
					},
					"work_status_string": {
						"type": "string",
						"description": "Required\nThe status of the works record as a string"
					},
					"additional_contact": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe name of an additional contact"
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe telephone number of an additional contact"
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe email address of an additional contact"
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe name of the emergency contact"
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nThe telephone number of the emergency contact"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpathResponse",
						"description": "Required\nWhether the footpath is closed, returned as 'no' if no value is stored"
					},
					"close_footpath_string": {
						"type": "string",
						"description": "Required\nWhether the footpath is closed as a string, returned as 'no' if no value is stored"
					},
					"street_line": {
						"description": "Optional\nThe street line as GeoJSON, only present if the works record holds one"
					},
					"road_category": {
						"type": "number",
						"format": "double",
						"description": "Required\nThe road category of the works record"
					}
				},
				"required": [
					"private_street_reference_number",
					"proposed_start_date",
					"proposed_end_date",
					"private_street_status",
					"private_street_status_string",
					"work_reference_number",
					"promoter_organisation",
					"promoter_swa_code",
					"secondary_contact",
					"secondary_contact_number",
					"calendar_day_duration",
					"working_day_duration",
					"description_of_work",
					"excavation",
					"street_name",
					"usrn",
					"highway_authority",
					"highway_authority_swa_code",
					"works_location_description",
					"works_coordinates",
					"date_created",
					"date_modified",
					"traffic_management_type",
					"traffic_management_type_string",
					"location_types",
					"location_types_string",
					"workstream_prefix",
					"close_footway",
					"close_footway_string",
					"work_status",
					"work_status_string",
					"close_footpath",
					"close_footpath_string",
					"road_category"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetNoticeCancelRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"cancellation_reason": {
						"type": "string",
						"description": "Required\nMust not be empty. Max length 500 characters\nRecorded on the private street notice and in the audit history"
					}
				},
				"required": [
					"cancellation_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationCreateResponse": {
				"properties": {
					"material_classification_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"material_classification_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationClassification": {
				"enum": [
					"hazardous",
					"non_hazardous"
				],
				"type": "string"
			},
			"HazardousMaterialType": {
				"enum": [
					"coal_tar",
					"total_petroleum_hydrocarbons",
					"ph",
					"heavy_metal",
					"asbestos",
					"other"
				],
				"type": "string"
			},
			"LayerAffected": {
				"enum": [
					"surface_course",
					"sub_base"
				],
				"type": "string"
			},
			"MaterialClassificationCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"highway_authority_swa_code": {
						"type": "string",
						"description": "Required\nMax length 4 characters\nMust match the organisation reference of an existing organisation (otherwise 404)"
					},
					"material_classification_coordinates": {
						"description": "Required\nMust be a GeoJSON point (using a British National Grid easting and northing coordinate pair)\nEastings must be between 80000 and 656100 and northings between 5000 and 657700"
					},
					"street_name": {
						"type": "string",
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided (or empty), populated with NSG data related to supplied USRN\nNote: the current validator applies a max length check without an optional guard, so omitting the property entirely is rejected with a 400"
					},
					"town": {
						"type": "string",
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"area_name": {
						"type": "string",
						"description": "Optional\nMax length 100 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information\nIf not provided, populated with NSG data related to supplied USRN"
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nIs whole number between 100001 and 99999999 inclusive\nMust exist in the street gazetteer (otherwise 404)\nSee business rules section 1.1.4 - USRN"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique"
					},
					"file_id": {
						"type": "number",
						"format": "double",
						"description": "Optional\nCan only be one file\nLimited to 10MBs\nMust exist and must not already be associated with another record"
					},
					"material_classification_classification": {
						"$ref": "#/components/schemas/MaterialClassificationClassification",
						"description": "Required"
					},
					"hazardous_material_type": {
						"items": {
							"$ref": "#/components/schemas/HazardousMaterialType"
						},
						"type": "array",
						"description": "Optional\nRequired if material_classification_classification is hazardous\nMust contain at least one value\nIgnored if material_classification_classification is not hazardous"
					},
					"hazardous_material_type_other_description": {
						"type": "string",
						"description": "Optional\nRequired if material_classification_classification is hazardous and hazardous_material_type includes other\nMax length 500 characters"
					},
					"layer_affected": {
						"items": {
							"$ref": "#/components/schemas/LayerAffected"
						},
						"type": "array",
						"description": "Required\nMust contain at least one value\nArray values must be unique"
					},
					"sample_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nMust be in the past (date and time)"
					},
					"location_description": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"highway_authority_swa_code",
					"material_classification_coordinates",
					"usrn",
					"location_types",
					"material_classification_classification",
					"layer_affected",
					"sample_date",
					"location_description"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationClassificationResponse": {
				"enum": [
					"hazardous",
					"non_hazardous",
					"upcoming_enum"
				],
				"type": "string"
			},
			"HazardousMaterialTypeResponse": {
				"enum": [
					"coal_tar",
					"total_petroleum_hydrocarbons",
					"ph",
					"heavy_metal",
					"asbestos",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"LayerAffectedResponse": {
				"enum": [
					"surface_course",
					"sub_base",
					"upcoming_enum"
				],
				"type": "string"
			},
			"MaterialClassificationResponse": {
				"properties": {
					"material_classification_reference_number": {
						"type": "string",
						"description": "Required\nReference number of the material classification, in the form {organisation prefix}{8 digit number}-MC."
					},
					"material_classification_coordinates": {
						"description": "Required\nGeoJSON point (British National Grid easting and northing) where the sample was taken."
					},
					"material_classification_classification": {
						"$ref": "#/components/schemas/MaterialClassificationClassificationResponse",
						"description": "Required\nWhether the material is hazardous or non-hazardous. An unrecognised value is returned as upcoming_enum."
					},
					"material_classification_classification_string": {
						"type": "string",
						"description": "Required\nThe classification as a string."
					},
					"hazardous_material_type": {
						"items": {
							"$ref": "#/components/schemas/HazardousMaterialTypeResponse"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nPresent only when the classification is hazardous, in which case it lists the hazardous material types recorded."
					},
					"hazardous_material_type_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional\nPresent only when the classification is hazardous, in which case it lists the hazardous material types as strings."
					},
					"hazardous_material_type_other_description": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nPresent only when the classification is hazardous and the hazardous material types include other."
					},
					"layer_affected": {
						"items": {
							"$ref": "#/components/schemas/LayerAffectedResponse"
						},
						"type": "array",
						"description": "Required\nThe road layers affected."
					},
					"layer_affected_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nThe road layers affected as strings."
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationTypeResponse"
						},
						"type": "array",
						"description": "Required\nThe types of location sampled."
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"description": "Required\nThe types of location sampled as strings."
					},
					"sample_date": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate and time the sample was taken."
					},
					"location_description": {
						"type": "string",
						"description": "Required\nDescription of the sample location."
					},
					"date_created": {
						"type": "string",
						"format": "date-time",
						"description": "Required\nDate and time the material classification was created."
					},
					"ha_swa_code": {
						"type": "string",
						"description": "Required\nSWA code of the highway authority the material classification belongs to, left-padded with zeros to 4 characters."
					},
					"ha_organisation_name": {
						"type": "string",
						"description": "Required\nName of the highway authority."
					},
					"usrn": {
						"type": "number",
						"format": "double",
						"description": "Required\nUnique Street Reference Number of the street."
					},
					"street_name": {
						"type": "string",
						"description": "Required\nName of the street."
					},
					"town": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nTown. Omitted when no town is recorded."
					},
					"area_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nArea name. Omitted when no area name is recorded."
					},
					"raised_by_swa_code": {
						"type": "string",
						"description": "Required\nSWA code of the organisation that raised the material classification, left-padded with zeros to 4 characters."
					},
					"raised_by_organisation_name": {
						"type": "string",
						"description": "Required\nName of the organisation that raised the material classification."
					},
					"file": {
						"allOf": [
							{
								"$ref": "#/components/schemas/FileSummaryResponse"
							}
						],
						"nullable": true,
						"description": "Optional\nThe evidence file attached to the material classification. Omitted when no file is attached."
					}
				},
				"required": [
					"material_classification_reference_number",
					"material_classification_coordinates",
					"material_classification_classification",
					"material_classification_classification_string",
					"layer_affected",
					"layer_affected_string",
					"location_types",
					"location_types_string",
					"sample_date",
					"location_description",
					"date_created",
					"ha_swa_code",
					"ha_organisation_name",
					"usrn",
					"street_name",
					"raised_by_swa_code",
					"raised_by_organisation_name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestCreateResponse": {
				"properties": {
					"change_request_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"change_request_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestCreateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"change_request_reason": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					},
					"secondary_contact": {
						"type": "string",
						"description": "Optional, validated only when included in the request\nMust not be empty\nMax length 100 characters"
					},
					"secondary_contact_number": {
						"type": "string",
						"description": "Optional, validated only when included in the request\nMust not be empty\nMax length 100 characters"
					},
					"secondary_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date",
						"description": "Optional, validated only when included in the request\nMust not be empty and must be a valid date\nThe period between proposed_start_date and proposed_end_date must not exceed 5 years\nIf proposed_start_time is not also included in the request, any existing proposed start time is cleared"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nproposed_start_date must also be included in the request\nRequired if proposed_start_date is in the past, and must then fall on the same day as proposed_start_date\nRequired if work_type is immediate"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date",
						"description": "Optional, validated only when included in the request\nMust not be empty and must be a valid date\nMust be on or after the actual start date if the work is in progress, otherwise on or after proposed_start_date\nIf proposed_end_time is not also included in the request, any existing proposed end time is cleared"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nproposed_end_date must also be included in the request\nRequired if proposed_end_date is in the past, and must then fall on the same day as proposed_end_date\nWhere it falls on the same day as the proposed start, it must be later than the proposed start time, or later than the actual start date and time if the work is in progress"
					},
					"description_of_work": {
						"type": "string",
						"description": "Optional, validated only when included in the request\nMust not be empty\nMax length 500 characters"
					},
					"excavation": {
						"type": "boolean",
						"description": "Optional, validated only when included in the request\nWhether an excavation will be required"
					},
					"project_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters"
					},
					"traffic_management_plan": {
						"type": "boolean",
						"description": "Optional, validated only when included in the request"
					},
					"lane_rental_applicable": {
						"type": "boolean",
						"description": "Optional, validated only when included in the request"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitCondition"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nEach condition value may only appear once\nEach comment max length 1500 characters"
					},
					"works_location_description": {
						"type": "string",
						"description": "Optional, validated only when included in the request\nMust not be empty\nMax length 500 characters"
					},
					"works_coordinates": {
						"nullable": true,
						"description": "Optional\nMust be a GeoJSON point, line string or polygon\nCoordinates are British National Grid easting and northing pairs; easting must be between 80000 and 656100, northing between 5000 and 657700\nA point must contain no more than two coordinate values"
					},
					"collaborative_working": {
						"type": "boolean",
						"description": "Optional, validated only when included in the request"
					},
					"collaboration_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is true\nMax length 500 characters\nRe-validated whenever collaborative_working changes"
					},
					"collaborative_works": {
						"type": "string",
						"nullable": true,
						"description": "Optional\nOnly saved if collaborative_working is true\nMax length 500 characters\nWork Reference Number of collaborative works"
					},
					"collaboration_type": {
						"allOf": [
							{
								"$ref": "#/components/schemas/CollaborationType"
							}
						],
						"nullable": true,
						"description": "Required if collaborative_working is true"
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityType",
						"description": "Optional, validated only when included in the request\nMust not be empty"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementType",
						"description": "Optional, validated only when included in the request\nMust not be empty"
					},
					"application_type": {
						"$ref": "#/components/schemas/ApplicationType",
						"description": "Optional, validated only when included in the request\nMust not be empty"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/LocationType"
						},
						"type": "array",
						"description": "Optional, validated only when included in the request\nMust contain at least one value and values must be unique\nbus_stop_or_stand, cycle_hire_docking_station, parking_place and taxi_rank may only be used when the promoter organisation is an HS2 organisation"
					},
					"early_start_pre_approval": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if the change request makes the permit an early-start permit and the existing permit is not already an early-start permit\nSee business rules section 3.4.6 - Early start"
					},
					"pre_approval_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is true\nMax length 500 characters"
					},
					"pre_approval_authoriser": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is true\nMax length 100 characters"
					},
					"early_start_reason": {
						"type": "string",
						"nullable": true,
						"description": "Required if early_start_pre_approval is false\nMax length 500 characters"
					},
					"work_type": {
						"$ref": "#/components/schemas/WorkType",
						"description": "Optional, validated only when included in the request\nMust not be empty\nhs2_highway_works may only be used when the promoter organisation is an HS2 organisation"
					},
					"is_ttro_required": {
						"type": "boolean",
						"nullable": true,
						"description": "Required when work_type is planned, and must not be set for any other work type"
					},
					"immediate_risk": {
						"type": "boolean",
						"nullable": true,
						"description": "Required when work_type is immediate, and must not be set for any other work type"
					},
					"file_ids": {
						"items": {
							"type": "number",
							"format": "double"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax 50 items and values must be unique\nMust not contain null or undefined values\nEach file must exist and must not already be associated with another record; any existing permit or change request association must be for the same works\nA file_id can only be associated with one section of Street Manager\nSee API specification Resource Guide > Works API > File upload for more information"
					},
					"additional_info": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 500 characters"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootway",
						"description": "Optional, validated only when included in the request\nMust not be empty"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpath",
						"description": "Optional, validated only when included in the request\nMust not be empty"
					},
					"permit_asds": {
						"items": {
							"$ref": "#/components/schemas/PermitASD"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nEach street_special_desig_code must be a valid special designation code\nEach special_desig_location_text max length 255 characters\nEach special_desig_description max length 300 characters"
					},
					"additional_contact": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters"
					},
					"additional_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters"
					},
					"additional_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters"
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMust be today or a date in the future"
					},
					"hs2_highway_emails": {
						"items": {
							"type": "string"
						},
						"type": "array",
						"nullable": true,
						"description": "Optional, validated only when the promoter organisation is an HS2 organisation and work_type is hs2_highway_works\nMax 2 items\nEach value must be a valid email address and max length 100 characters"
					},
					"emergency_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if traffic_management_type is multi_way_signals or two_way_signals\nMax length 100 characters\nRe-validated whenever traffic_management_type changes"
					},
					"emergency_contact_number": {
						"type": "string",
						"nullable": true,
						"description": "Required if traffic_management_type is multi_way_signals or two_way_signals\nMax length 100 characters\nRe-validated whenever traffic_management_type changes"
					},
					"is_primary_promoter": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if collaborative_working is true\nRe-validated whenever collaborative_working changes"
					},
					"collaboration_types": {
						"items": {
							"$ref": "#/components/schemas/CollaborationType"
						},
						"type": "array",
						"nullable": true,
						"description": "Required if collaborative_working is true or others_can_collaborate_on_work is true\nMust contain at least one value and values must be unique\nMust not contain both trench_sharing_primary_promoter and trench_sharing_secondary_promoter\nMust not contain trench_sharing_secondary_promoter when is_primary_promoter is true, or trench_sharing_primary_promoter when is_primary_promoter is false\nRe-validated whenever collaborative_working or others_can_collaborate_on_work changes"
					},
					"primary_promoter_permit_reference_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters\nMust be the reference number of an existing permit\nCan only be set where the permit is already collaborative working with another promoter as primary, or where the change request sets collaborative_working to true with is_primary_promoter false"
					},
					"collaboration_contact_name": {
						"type": "string",
						"nullable": true,
						"description": "Required if collaborative_working is true or others_can_collaborate_on_work is true\nMax length 100 characters\nRe-validated whenever collaborative_working or others_can_collaborate_on_work changes"
					},
					"collaboration_contact_email": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters\nAt least one of collaboration_contact_email or collaboration_contact_phone_number must be provided when collaborative_working is true or others_can_collaborate_on_work is true"
					},
					"collaboration_contact_phone_number": {
						"type": "string",
						"nullable": true,
						"description": "Optional, validated only when included in the request\nMax length 100 characters\nAt least one of collaboration_contact_email or collaboration_contact_phone_number must be provided when collaborative_working is true or others_can_collaborate_on_work is true"
					},
					"estimated_number_of_network_days_saved": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Required if is_primary_promoter is false\nMust be a whole number of 0 or greater\nRe-validated whenever is_primary_promoter changes"
					},
					"others_can_collaborate_on_work": {
						"type": "boolean",
						"nullable": true,
						"description": "Required if collaborative_working is false\nRe-validated whenever collaborative_working changes"
					},
					"reason_for_non_collaboration": {
						"type": "string",
						"nullable": true,
						"description": "Required if others_can_collaborate_on_work is false\nMax length 500 characters\nRe-validated whenever others_can_collaborate_on_work changes"
					},
					"can_collaborate_on_work_additional_details": {
						"type": "string",
						"nullable": true,
						"description": "Required if others_can_collaborate_on_work is true\nMax length 500 characters\nRe-validated whenever others_can_collaborate_on_work changes"
					}
				},
				"required": [
					"change_request_reason"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestStatus": {
				"enum": [
					"submitted",
					"granted",
					"refused",
					"deemed",
					"cancelled",
					"granted_with_duration_challenge",
					"revoked",
					"auto_applied"
				],
				"type": "string"
			},
			"ChangeRequestStatusUpdateRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"change_request_status": {
						"$ref": "#/components/schemas/ChangeRequestStatus",
						"description": "Can only be set to granted, refused or granted_with_duration_challenge"
					},
					"assessment_comments": {
						"type": "string",
						"nullable": true,
						"description": "Required if change_request_status is refused or granted_with_duration_challenge\nMax length 1500 characters\nMust not be provided if change_request_status is granted"
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Optional, and only used if change_request_status is granted\nWhole number between 0 and 100 inclusive"
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if change_request_status is granted_with_duration_challenge\nMust be on or after the current reasonable period end date of the permit and on or before the proposed end date of the change request"
					}
				},
				"required": [
					"change_request_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestASDResponse": {
				"properties": {
					"special_desig_location_text": {
						"type": "string",
						"nullable": true,
						"description": "Max length 255 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_description": {
						"type": "string",
						"nullable": true,
						"description": "Max length 300 characters\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_start_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Use Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"special_desig_end_time": {
						"type": "number",
						"format": "double",
						"nullable": true,
						"description": "Is whole number between 0 and 2400 inclusive\nUse Street Lookup API endpoint /nsg/streets to lookup this information"
					},
					"asd_coordinate_geometry": {
						"nullable": true,
						"description": "Is a GeoJSON geometry (using British National Grid easting and northing coordinate pairs) and is either a point, line string or polygon"
					},
					"street_special_desig_code": {
						"$ref": "#/components/schemas/ASDCodeResponse"
					},
					"street_special_desig_code_string": {
						"type": "string"
					},
					"special_desig_periodicity_code": {
						"allOf": [
							{
								"$ref": "#/components/schemas/ASDPeriodicityCodeResponse"
							}
						],
						"nullable": true
					},
					"special_desig_periodicity_code_string": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"street_special_desig_code",
					"street_special_desig_code_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestLocationTypeResponse": {
				"enum": [
					"footway",
					"carriageway",
					"verge",
					"cycleway",
					"footpath",
					"parking_place",
					"bus_stop_or_stand",
					"cycle_hire_docking_station",
					"taxi_rank",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ChangeRequestConditionTypeResponse": {
				"enum": [
					"NCT01a",
					"NCT01b",
					"NCT02a",
					"NCT02b",
					"NCT04a",
					"NCT04b",
					"NCT05a",
					"NCT06a",
					"NCT07a",
					"NCT08a",
					"NCT08b",
					"NCT09a",
					"NCT09b",
					"NCT09c",
					"NCT10a",
					"NCT11a",
					"NCT11b",
					"NCT12a",
					"NCT09d",
					"NCT03",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ChangeRequestConditionResponse": {
				"properties": {
					"condition": {
						"$ref": "#/components/schemas/ChangeRequestConditionTypeResponse"
					},
					"condition_string": {
						"type": "string"
					},
					"comment": {
						"type": "string",
						"nullable": true,
						"description": "Max length 1500 characters"
					}
				},
				"required": [
					"condition",
					"condition_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestCollaborationTypeResponse": {
				"enum": [
					"trench_sharing_primary_promoter",
					"trench_sharing_secondary_promoter",
					"sharing_traffic_management_only",
					"other",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ProposedChangeRequestResponse": {
				"properties": {
					"secondary_contact": {
						"type": "string"
					},
					"secondary_contact_number": {
						"type": "string"
					},
					"secondary_contact_email": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time"
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"calendar_day_duration": {
						"type": "number",
						"format": "double"
					},
					"working_day_duration": {
						"type": "number",
						"format": "double"
					},
					"description_of_work": {
						"type": "string"
					},
					"excavation": {
						"type": "boolean"
					},
					"project_reference_number": {
						"type": "string"
					},
					"traffic_management_plan": {
						"type": "boolean"
					},
					"lane_rental_applicable": {
						"type": "boolean"
					},
					"works_location_description": {
						"type": "string"
					},
					"collaborative_working": {
						"type": "boolean"
					},
					"collaboration_details": {
						"type": "string"
					},
					"collaborative_works": {
						"type": "string"
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityTypeResponse"
					},
					"activity_type_string": {
						"type": "string"
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponseEnum"
					},
					"work_category_string": {
						"type": "string"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"application_type": {
						"$ref": "#/components/schemas/ApplicationTypeResponse"
					},
					"application_type_string": {
						"type": "string"
					},
					"collaboration_type": {
						"$ref": "#/components/schemas/CollaborationTypeResponse"
					},
					"collaboration_type_string": {
						"type": "string"
					},
					"traffic_management_required": {
						"type": "boolean"
					},
					"is_ttro_required": {
						"type": "boolean"
					},
					"immediate_risk": {
						"type": "boolean"
					},
					"is_early_start": {
						"type": "boolean"
					},
					"early_start_pre_approval": {
						"type": "boolean"
					},
					"pre_approval_details": {
						"type": "string"
					},
					"pre_approval_authoriser": {
						"type": "string"
					},
					"early_start_reason": {
						"type": "string"
					},
					"additional_info": {
						"type": "string"
					},
					"work_type": {
						"$ref": "#/components/schemas/WorkTypeResponse"
					},
					"work_type_string": {
						"type": "string"
					},
					"validity_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"close_footway": {
						"$ref": "#/components/schemas/CloseFootwayResponse"
					},
					"close_footway_string": {
						"type": "string"
					},
					"is_traffic_sensitive": {
						"type": "boolean"
					},
					"additional_contact": {
						"type": "string"
					},
					"additional_contact_number": {
						"type": "string"
					},
					"additional_contact_email": {
						"type": "string"
					},
					"hs2_consultation_requested_response_date": {
						"type": "string",
						"format": "date-time"
					},
					"hs2_highway_emails": {
						"items": {
							"type": "string"
						},
						"type": "array"
					},
					"paa_to_pa_deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"emergency_contact_name": {
						"type": "string"
					},
					"emergency_contact_number": {
						"type": "string"
					},
					"close_footpath": {
						"$ref": "#/components/schemas/CloseFootpathResponse"
					},
					"close_footpath_string": {
						"type": "string"
					},
					"potential_clash_with_other_works": {
						"type": "boolean"
					},
					"others_can_collaborate_on_work": {
						"type": "boolean"
					},
					"reason_for_non_collaboration": {
						"type": "string"
					},
					"can_collaborate_on_work_additional_details": {
						"type": "string"
					},
					"collaboration_contact_name": {
						"type": "string"
					},
					"collaboration_contact_email": {
						"type": "string"
					},
					"collaboration_contact_phone_number": {
						"type": "string"
					},
					"is_primary_promoter": {
						"type": "boolean"
					},
					"primary_promoter_permit_reference_number": {
						"type": "string"
					},
					"estimated_number_of_network_days_saved": {
						"type": "number",
						"format": "double"
					},
					"permit_coordinates": {},
					"files": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array"
					},
					"permit_asds": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestASDResponse"
						},
						"type": "array"
					},
					"permit_asds_not_selected": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestASDResponse"
						},
						"type": "array"
					},
					"location_types": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestLocationTypeResponse"
						},
						"type": "array"
					},
					"location_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					},
					"conditions": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestConditionResponse"
						},
						"type": "array"
					},
					"collaboration_types": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestCollaborationTypeResponse"
						},
						"type": "array"
					},
					"collaboration_types_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					}
				},
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestResponse": {
				"properties": {
					"change_request_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"change_request_status": {
						"$ref": "#/components/schemas/ChangeRequestStatusResponse"
					},
					"change_request_status_string": {
						"type": "string"
					},
					"change_request_type": {
						"$ref": "#/components/schemas/ChangeRequestTypeResponse"
					},
					"change_request_type_string": {
						"type": "string"
					},
					"permit_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/PermitStatusResponse"
							}
						],
						"nullable": true
					},
					"permit_status_string": {
						"type": "string",
						"nullable": true
					},
					"assessment_discount": {
						"type": "number",
						"format": "double",
						"nullable": true
					},
					"assessment_comments": {
						"type": "string",
						"nullable": true
					},
					"change_request_reason": {
						"type": "string"
					},
					"current": {
						"$ref": "#/components/schemas/PermitResponse"
					},
					"proposed": {
						"$ref": "#/components/schemas/ProposedChangeRequestResponse"
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status_string": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_reason_for_non_acceptance": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_review_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_details": {
						"type": "string",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_new_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_non_acceptance_response_old_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true
					},
					"assessment_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					}
				},
				"required": [
					"change_request_reference_number",
					"date_created",
					"deadline_date",
					"change_request_status",
					"change_request_status_string",
					"change_request_type",
					"change_request_type_string",
					"change_request_reason",
					"current",
					"proposed"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestDurationChallengeReviewRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"review_status": {
						"$ref": "#/components/schemas/DurationChallengeReviewStatus",
						"description": "Required\nCan only be set to duration_challenge_accepted or duration_challenge_not_accepted"
					},
					"reason_for_non_acceptance": {
						"type": "string",
						"nullable": true,
						"description": "Required if review_status is duration_challenge_not_accepted\nMax length 500 characters\nNot stored if review_status is duration_challenge_accepted"
					}
				},
				"required": [
					"review_status"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestDurationChallengeNonAcceptanceResponseRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"non_acceptance_response_status": {
						"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatus",
						"description": "Required\nCan only be set to reasonable_period_end_date_changed or reasonable_period_end_date_not_changed"
					},
					"new_reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true,
						"description": "Required if non_acceptance_response_status is reasonable_period_end_date_changed\nNot stored if non_acceptance_response_status is reasonable_period_end_date_not_changed"
					},
					"non_acceptance_response_details": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"non_acceptance_response_status",
					"non_acceptance_response_details"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestImposeChangeResponse": {
				"properties": {
					"change_request_reference_number": {
						"type": "string"
					}
				},
				"required": [
					"change_request_reference_number"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestImposeChangeRequest": {
				"properties": {
					"internal_user_identifier": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"internal_user_name": {
						"type": "string",
						"nullable": true,
						"description": "Optional, max length 100 characters"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitCondition"
						},
						"type": "array",
						"nullable": true,
						"description": "The complete set of conditions that should apply to the permit after the change; any condition not included is removed\nMust be provided - a request without conditions is rejected\nEach condition may only appear once\nEach condition comment has a max length of 1500 characters"
					},
					"change_request_reason": {
						"type": "string",
						"description": "Required\nMax length 500 characters"
					}
				},
				"required": [
					"change_request_reason"
				],
				"type": "object",
				"additionalProperties": false
			}
		},
		"securitySchemes": {
			"token": {
				"type": "apiKey",
				"name": "token",
				"in": "header"
			}
		}
	},
	"info": {
		"title": "Street Manager API Stable",
		"version": "1.0.0",
		"description": "See API specification Resource Guide > Work 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": {}
	},
	"servers": [
		{
			"url": "/"
		}
	],
	"paths": {
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}": {
			"get": {
				"operationId": "GetPermit",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a permit, using the current version of the permit and its related details.\nAccess: Planner, Contractor or HighwayAuthority role. No read-access check is applied to the works. Lane rental cost values (potential, estimated and final cost, and per-charge discount and total cost) are only returned to non-Contractor users with write access to the works.\nBusiness constraints: the permit must exist and belong to the works (404).\nSee business rules section 2.1.4 - PAA and permit applications (PA)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits": {
			"post": {
				"operationId": "CreatePermit",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Creates a new permit application (PAA or PA) on an existing works record. The permit category (PAA, minor, standard, major, immediate or HS2 highway) and whether it is an early start are calculated from your request. If the works has an active permit, it is replaced by the new permit, and an active PAA that is ready to progress is progressed to a PA. If the works has a raised forward plan, it is progressed. For historic or non-notifiable works with no permits, the new permit becomes the first permit.\nAccess: Planner or Contractor role with write access to the works (401 otherwise).\nBusiness constraints: the works, the non-compliance (if non_compliance_reference_number is supplied) and the street for the works USRN must exist (404). Request fields are validated (400), including the work type rules, the 5 year maximum duration, proposed start and end times, works_coordinates, workstream_prefix, early start, collaboration, HS2 and traffic management contact fields. A linked non-compliance must be issued and linked to the same works. works_coordinates points must have 2 values. The works and street must not be fully private. An active permit must not already exist (unless the works is completed or cancelled, or the active permit is refused or a PAA), and a PAA cannot be raised while the active permit is a submitted or granted PAA. workstream_prefix cannot differ from the works existing workstream. A forward plan must be raised and its HS2 work type must match the request. With no active permit and no forward plan, the works must be historic or non-notifiable, and any workstream_prefix must exist in your organisation. file_ids must exist and not already be used elsewhere (412).\nSee business rules section 2.1.4 - PAA and permit applications (PA)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/status": {
			"put": {
				"operationId": "UpdatePermitStatus",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Cancels a PAA or permit, sets the works status to cancelled, cancels any outstanding change request on the permit and removes the permit's ancillary information.\nAccess: Planner or Contractor role with write access to the works (401 otherwise); the permit must exist and belong to the works (404).\nBusiness constraints: the permit must be the active permit, and the works must be planned or, for immediate permits, in progress; the permit must have no reinstatements recorded against it; a PAA cannot be cancelled once a PA raised from it has been assessed (412).\nSee business rules section 2.1.4.9 - Cancelling PAA & PA",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitStatusUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/assessment": {
			"put": {
				"operationId": "UpdateAssessmentStatus",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records the highway authority's assessment decision (grant, refuse, revoke, request modification) on a permit.\nAccess: HighwayAuthority role with write access to the works; the permit must exist on the works (404 otherwise, 401 without write access).\nBusiness constraints (412): the permit must be the active permit. Grant and refuse require a permit not already granted, refused or revoked and not cancelled (a permit awaiting modification can still be assessed), and a PAA that has not been superseded by a PA. A grant with a challenged duration needs a reasonable period end date giving at least 2 working days and no later than the permit end date. Revoke requires a granted permit that is not an HS2 consultation permit. Modification request requires a standard, minor, major or HS2 highway permit that is submitted or under assessment and has not already had a modification requested.\nSee business rule section 5 - Revoking a PA\nSee business rule section 3.4.7 - PAA & PA assessment decision options",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitAssessmentUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/permit-discount": {
			"put": {
				"operationId": "UpdatePermitDiscount",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Updates the discount applied to a granted permit and recalculates the total cost of its granted chargeable item.\nAccess: HighwayAuthority role, and the user's organisation must be the highway authority for the works (401 otherwise).\nBusiness constraints: the work and permit must exist and the permit must belong to the work (404 otherwise); the request body must be valid (400 otherwise); the permit assessment status must be granted or granted automatically (412 otherwise).",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitDiscountUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/lane-rental-assessments": {
			"put": {
				"operationId": "UpdatePermitLaneRentalAssessment",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Records a lane rental assessment on a permit, replacing any current charge details and adding an entry to the assessment history.\nAccess: HighwayAuthority role with write access to the works.\nBusiness constraints: a lane rental assessment cannot be added to a permit that is an HS2 consultation or whose current work category is HS2 highway works (412). A chargeable outcome requires charges_agreed; charge_band and chargeable_days are optional and any value not supplied keeps the value already held on the permit. Only one charge band is recorded, and the permit's lane rental status always becomes assessed final.\nSee business rules section 2.4.2 - Adding a lane rental assessment to a PA",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitLaneRentalAssessmentUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/hs2_acknowledgement": {
			"put": {
				"operationId": "AcknowledgeHS2Permit",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Acknowledges receipt of an HS2 consultation permit.\nAccess: HighwayAuthority role; the permit must exist on the given works (404) and the user's organisation must be the highway authority for the works (401).\nBusiness constraints: the permit must be an HS2 consultation and must not already have been acknowledged (412).",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/HS2AcknowledgementRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/duration-challenge-review": {
			"put": {
				"operationId": "UpdatePermitDurationChallengeReview",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records the promoter's review (accepted or not accepted) of a permit granted with duration challenge.\nAccess: Planner or Contractor role; the permit must exist on the named works (404); the user must have write access to the works (401), which a Contractor loses if the promoter organisation is suspended or disabled.\nBusiness constraints (412, checked after field validation): the permit must be the active permit; it must be granted and duration challenged; the duration challenge review must not already be complete; if a review has already been submitted, a further review is only allowed once the highway authority has recorded a non-acceptance response.\nSee business rules section 21.1 - Duration challenge review",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitDurationChallengeReviewRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/duration-challenge-non-acceptance-response": {
			"put": {
				"operationId": "UpdatePermitDurationChallengeNonAcceptanceResponse",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records the highway authority's response when a promoter does not accept a permit duration challenge.\nAccess: Highway authority users only; the permit must exist on the named works (404) and the user's organisation must be the highway authority organisation on the works (401).\nBusiness constraints (412): the permit must be the active permit and be granted with a duration challenge; no response may already have been recorded; the promoter must have not accepted the challenge; when the reasonable period end date is changed, the new date must allow at least two working days from the permit start date and be on or before the permit end date.\nSee business rules section 2.6.3 - Non-Acceptance of a Duration Challenge",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitDurationChallengeNonAcceptanceResponseRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/current-traffic-management-type": {
			"put": {
				"operationId": "UpdateCurrentTrafficManagementType",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the traffic management type currently in use on in-progress works.\n\nAccess: Planner or Contractor role; the permit must exist under the given works reference (404); the user must have write access to the works (401).\nBusiness constraints: the works must be in progress (412); the new type must not be a higher priority than the traffic management type on the permit (412).\n\nSee business rules section 2.1.6 - Changes to traffic management",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/CurrentTrafficManagementTypeRequest"
							}
						}
					}
				}
			}
		},
		"/permits/category": {
			"get": {
				"operationId": "GetWorkCategory",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkCategoryResponse"
								}
							}
						}
					}
				},
				"description": "Utility endpoint that calculates the work category a permit would be assigned, together with the duration, validity period end date and whether it would be an early start. Nothing is saved.\nAccess: Planner, Contractor or HighwayAuthority role. No organisation or works ownership check is applied.\nBusiness constraints:\n- work_reference_number, if supplied, must belong to an existing works record (404 Not Found). This is checked before the other validation.\n- work_type and activity_type are always required and must be valid enum values (400 Bad Request).\n- When work_type is planned: proposed_start_date, proposed_end_date and is_ttro_required are required (400). The end date must be on or after the start date (date-only comparison), and the end date must be no more than 1826 days (5 years) after the start date (400).\n- When work_type is not planned: proposed_start_date and proposed_end_date are not validated, and is_ttro_required must not be supplied (400).\n- When work_type is immediate: immediate_risk is required (400). When work_type is not immediate: immediate_risk must not be supplied (400).\n- work_reference_number has a maximum length of 100 characters (400).\n- Category: hs2_highway_works gives hs2_highway; immediate gives immediate_emergency if immediate_risk is true, otherwise immediate_urgent. For planned works, \"major timings\" means is_ttro_required is true or more than 10 working days. With a work_reference_number and an active permit, the category is major if the active permit is a submitted/granted PAA, or if major timings apply and the works has a closed/progressed permit or is in progress. Otherwise major timings give paa (major if activity_type is optional_permit_no_fee), 3 working days or fewer gives minor, and anything else gives standard.\n- is_early_start is only ever true for planned works. It is false when the works (via work_reference_number) is in progress and was not itself an early start.\n- validity_period_end_date is calculated for major, standard (5 working days) and minor (2 working days) only; for other categories it is the proposed start date.\nSee business rules section 3.4.3 - Works categories",
				"security": [
					{
						"token": [
							"HighwayAuthority",
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "work_type",
						"required": true,
						"schema": {
							"$ref": "#/components/schemas/WorkType"
						}
					},
					{
						"in": "query",
						"name": "proposed_start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "proposed_end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "is_ttro_required",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"in": "query",
						"name": "immediate_risk",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "activity_type",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ActivityType"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/earliest-permit": {
			"get": {
				"operationId": "GetEarliestPermit",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitSummaryResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a summary of the permit with the earliest actual start date on a works record.\n\nAccess: Planner, Contractor or HighwayAuthority role; no check is made that the works belong to the caller's organisation or workstream. Returns 404 if the works record has no permits.\nBusiness constraints: permits that have no actual start date are ordered after permits that have one; if no permit has started, which permit is returned is not defined by the ordering. The summary reflects the current version of the selected permit.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/under-assessment": {
			"put": {
				"operationId": "MarkPermitAsUnderAssessment",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Marks a permit as under assessment, which stops an immediate permit being auto-granted when the works are stopped.\n\nAccess: HighwayAuthority role with write access to the works (the user's organisation must be the works' highway authority organisation); returns 404 if the permit does not exist on the works and 401 if the user lacks write access.\nBusiness constraints: the permit must be the active permit, must not already have a final assessment decision (a permit with a modification requested is allowed), must not be cancelled, closed or already under assessment, and must not be a PAA; otherwise 412. The optional body only carries delegated user identification, which is recorded in the audit.",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": false,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/MarkPermitAsUnderAssessmentRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/link-non-compliance": {
			"put": {
				"operationId": "LinkPermitToNonCompliance",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Links a permit to an issued non-compliance on the same works.\nAccess: Planner or Contractor role; the permit must exist on the works (404) and the user must have write access to the works (401). For a Contractor, write access is refused if the promoter organisation is suspended or disabled.\nBusiness constraints: the referenced non-compliance must exist (404, reference is not case-sensitive). The non-compliance and the permit must both belong to the works; the permit must not be refused, revoked, cancelled or progressed; the non-compliance must have a status of issued; and the permit must not already be linked to that non-compliance (all 412).",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PermitNonComplianceLinkRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}": {
			"get": {
				"operationId": "GetWork",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a works record with its permits, sites, inspections and other related records, each limited to the most recent items.\nAccess: Planner, Contractor or HighwayAuthority role. Planners and Contractors need read access to the works' workstream in the promoter organisation, and a Contractor is refused if that organisation is suspended or disabled. Highway Authority users can read any works.\nBusiness constraints: The works must exist (404). You must have read access to the works (401).\nSee business rules section 3 - Works submissions and applications",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works": {
			"post": {
				"operationId": "CreateWork",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Creates a works record with its first permit. The work category is calculated from the request.\nAccess: Planner or Contractor role with permission to create works for promoter_swa_code and workstream_prefix.\nBusiness constraints: highway_authority_swa_code must exist (404); the USRN must exist in the NSG (404); work_reference_number must be unique (409). file_ids must exist and not already be linked to another record; road_category must not be 9 (private street) and must be supplied on a partially private street; the street must not be fully private; a point in works_coordinates must have exactly 2 values; workstream_prefix, if supplied, must exist in the promoter organisation (412).\nSee business rules section 2.1 - Works submissions and applications",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/WorkCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/start": {
			"put": {
				"operationId": "UpdateActualStartDate",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Logs the actual start date of works on the active permit, which moves the works to in progress and may shift the proposed end date.\nAccess: Planner or Contractor role with the Work permission for the works (401); the works must exist (404); write access to the works' workstream, and for a Contractor the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: the works must have a permit (412); the actual start date must not already be set (412); the permit status must be granted, submitted, permit_modification_request or under_assessment (412); the permit must not be a PAA (412). Request body validation failures return 400.\nSee business rules section 6.1 - Logging works start",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/WorkStartUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/revert-start": {
			"put": {
				"operationId": "RevertActualStartDate",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Reverts the actual start date of works, returning the works to planned and restoring any shifted proposed end date.\nAccess: Planner or Contractor role with the Work permission for the works (401); the works must exist (404); write access to the works' workstream, and for a Contractor the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: the works must have a permit; the works must be in progress; the permit must not be revoked; the works must not be immediate; there must be no active reinstatements on the permit (all 412). Request body validation failures return 400.\nSee business rules section 6.2 - Reverting works start",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/WorkStartRevertRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/stop": {
			"put": {
				"operationId": "UpdateActualStopDate",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Logs the actual stop date of works, which closes the active permit, completes the works, recalculates the permit duration and, where the criteria are met, adds inspection units.\nAccess: Planner or Contractor role with the Work permission for the works (401); the works must exist (404); write access to the works' workstream, and for a Contractor the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: actual_stop_date is required and must be before the current date and time; it must be no more than 1826 days after the actual start date of the active permit, when the works have one (all 400). The works must have a permit; actual_stop_date must not already be set; the works must be in progress; actual_stop_date must be after the actual start date (all 412).\nSee business rules section 2.8.3 - Logging works stop",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/WorkStopUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/revert-stop": {
			"put": {
				"operationId": "RevertActualStopDate",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Reverts the actual stop date of works, which reopens the active permit, returns the works to in progress, restores the proposed end date and, where inspection units were added at stop, reverses them.\nAccess: Planner or Contractor role with the Work permission for the works (401); the works must exist (404); write access to the works' workstream, and for a Contractor the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: revert_reason is required and at most 500 characters; internal_user_identifier and internal_user_name are optional and at most 100 characters (all 400). The works must have a permit; the works must be completed (both 412).\nSee business rules section 2.8.4 - Reverting works stop",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/WorkStopRevertRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/history": {
			"get": {
				"operationId": "GetWorkHistory",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkHistoryResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves the paginated audit history of a works record, newest events first, 25 events per page. Read-only: no audit record or notification is created.\nAccess: Planner, Contractor or HighwayAuthority role. Planners and Contractors need read access to the works' workstream in the promoter organisation, and a Contractor is refused if that organisation is suspended or disabled. Highway Authority users can read any works.\nBusiness constraints: The works must exist (404). You must have read access to the works (401). offset is optional and must be 0 or greater (400).\nSee business rules section 2.9.2 - Works history",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/sites": {
			"post": {
				"operationId": "CreateSite",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/SiteCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a site with its first reinstatement on a works record.\nAccess: Planner or Contractor role with write access to the works (401 otherwise). The works must exist (404).\nBusiness constraints: permit_reference_number, if supplied, must match an existing permit (404). The request body must pass validation (400).\nReinstatement constraints apply (412): the works must be in progress, completed or non-notifiable; a works record cannot have more than 999 sites; point coordinates must contain a single coordinate pair; excavation cannot be added to non-notifiable works, requires an excavation to have been carried out, and reinstatement_date must not be before the actual start date of the earliest permit on the works; file_ids must exist and must not already be used elsewhere.\nSee business rules section 2.10 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/SiteCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/sites/{siteReferenceNumber}": {
			"get": {
				"operationId": "GetSite",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/SiteResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a site and its reinstatements (newest first, up to 50).\nAccess: Authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority, and read access to the work.\nReturns 404 if the work or the site on that work is not found; 401 if the user does not have read access to the work.\nSee business rules section 2.10 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "siteReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/sites/{siteReferenceNumber}/subsume": {
			"put": {
				"operationId": "SubsumeSite",
				"responses": {
					"204": {
						"description": "No content"
					}
				},
				"description": "Marks a site as subsumed and records the reason. The site's active reinstatement is copied into a new active reinstatement (with depth, length and width cleared).\nAccess: Planner or Contractor role with write access to the works (401 otherwise). The works must exist (404) and the site must exist on those works (404).\nBusiness constraints: subsume_reason is required and at most 500 characters; internal_user_identifier and internal_user_name are optional, at most 100 characters each (400). The site must not already be subsumed (412: \"The site has already been subsumed\").\nReturns 204 No Content on success.\nSee business rules section 2.10 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "siteReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/SubsumeSiteRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/sites/{siteReferenceNumber}/reinstatements": {
			"post": {
				"operationId": "CreateReinstatement",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReinstatementCreateResponse"
								}
							}
						}
					}
				},
				"description": "Adds a reinstatement to an existing site.\n\nAccess: the user must have the Planner or Contractor role; the site must exist on the works and the user must have write access to the works; permit_reference_number, if supplied, must exist.\nBusiness constraints: reinstatement coordinates must be valid (a point may contain only one coordinate pair); the works must be planned, in progress, completed or non-notifiable; the site must not be subsumed; the works must not exceed 999 sites; reinstatements cannot be added to a forward plan without a permit; for excavation sites an excavation must have been carried out, the reinstatement date must be after the actual start date and an interim site can only be made permanent under a new permit; every supplied file must exist and must not already be associated with another record.\n\nSee business rules section 8 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "siteReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ReinstatementCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/sites/{siteReferenceNumber}/reinstatements/{reinstatementReferenceNumber}": {
			"delete": {
				"operationId": "DeleteReinstatement",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Deletes a reinstatement from a site. If it was the site's only reinstatement the site is deleted too; if it was the active reinstatement the most recently created remaining reinstatement becomes active.\n\nAccess: the user must have the Planner or Contractor role (401); the reinstatement must exist on the given site and works (404); the user must have write access to the works (401 Access restricted): Planner or Contractor needs full write access to the works' workstream, and a Contractor is refused if the promoter organisation is suspended or disabled.\nBusiness constraints: none beyond access; no request body or other validation is applied. All changes are made in a single transaction and audited.\n\nSee business rules section 2.10 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "siteReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "reinstatementReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/inspections/{inspectionReferenceNumber}": {
			"get": {
				"operationId": "GetInspection",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/InspectionResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves an inspection on a works record, including its failure reasons, files and linked non-compliance reference numbers.\nAccess: Planner, Contractor or HighwayAuthority role. HighwayAuthority users can read any works. Planner and Contractor users need read access to the works' workstream; Contractor users are also refused if the promoter organisation is suspended or disabled (401).\nBusiness constraints: the works must exist (404). The inspection must exist and belong to the works in the path (404); the inspection reference number and works reference number are matched case-insensitively.\nSee business rules section 4.1 - Inspections",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "inspectionReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			},
			"delete": {
				"operationId": "DeleteInspection",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Deprecated: use PUT works/{workReferenceNumber}/inspections/{inspectionReferenceNumber}/withdraw instead. Permanently deletes an inspection from a works record. Returns 204 No Content with no response body.\nAccess: HighwayAuthority role with the Compliance permission (401), and write access to the works (401). The inspection must exist on the works (404). Checks are made in that order: Compliance permission, inspection exists, write access.\nBusiness constraints: none. The status of the inspection is not checked.\nSide effects: the inspection, its failure reasons, its file links and the linked files are permanently removed. An audit record is created and the works' updated date is refreshed.",
				"deprecated": true,
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "inspectionReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/inspections": {
			"post": {
				"operationId": "CreateInspection",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/InspectionCreateResponse"
								}
							}
						}
					}
				},
				"description": "Records an inspection against a works record, optionally linking it to an existing non-compliance or raising a new one when it fails.\nAccess: HighwayAuthority role with the Compliance permission and write access to the works (401 otherwise).\nBusiness constraints: the works must exist and any non_compliance_reference_number supplied must exist (404). The request body must pass validation (400). The works must have a permit, unless it is historical, non-notifiable or Section 81 (412). file_ids must exist and must not already be linked to another record (412). Failed inspections on works with sites must name sites that exist on the works (412). A linked non-compliance must belong to the works and have a status of issued (412). Section 81 inspections and reinspections are only allowed on Section 81 works with attributed types, and other inspection types are not allowed on those works (412). Category A inspections need an active, unmet PBI target, and category B and C inspections need a matching issued PBI sample (412).\nSee business rules section 10 - Inspections and non-compliance",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/InspectionCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/inspections/{inspectionReferenceNumber}/withdraw": {
			"put": {
				"operationId": "WithdrawInspection",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Withdraws an inspection. Returns 204 with no body on success.\nAccess: HighwayAuthority role with the Compliance permission and write access to the works, i.e. a user of the works' highway authority organisation (401 otherwise).\nBusiness constraints: the request body must pass validation (400). The inspection must exist and belong to the works in the path, matched case-insensitively (404). The inspection must not already be withdrawn (412).\nSide effects: the inspection is set to withdrawn with the supplied reason and details, and its highway authority response status is set to inspection withdrawn. Category A, B and C inspections adjust the in-progress PBI sample inspection target actuals (category A when the inspection was created on or after the target start date, B and C when the inspection's sample belongs to the target). If the inspection is linked to a non-compliance and no other recorded inspections remain on it, that non-compliance is also withdrawn. Audit records are created and the works' updated date is refreshed.\nSee business rules section 10 - Inspections and non-compliance",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "inspectionReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/InspectionWithdrawRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/inspections/{inspectionReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateInspectionOutcomeStatus",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records a promoter or highway authority response to a failed inspection outcome.\nAccess: Planner, Contractor or HighwayAuthority role with the Compliance permission for the works (401), and write access to the works (401). The inspection must exist on the works (404).\nBusiness constraints: the response type must be one of the values allowed for the user's role, and a reason is required for some response types (400). The inspection must have a status of recorded, and the existing promoter and HA responses must allow the requested response type (412). Planners and Contractors can only respond to failed inspections.\nSee business rules section 4.1.3 - Inspection outcomes (promoter response and Highway Authority response)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "inspectionReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/InspectionOutcomeStatusRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/scheduled-inspections": {
			"delete": {
				"operationId": "DeleteScheduledInspection",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Deletes (cancels) the scheduled inspection on a works.\n\nAccess: the user must have the HighwayAuthority role with the Compliance permission; the works must exist (404) and the user must have write access to it (401).\nBusiness constraints: the works must have a scheduled inspection (412).\n\nSee business rules section 4.1.4 - Scheduling inspections",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			},
			"post": {
				"operationId": "CreateScheduledInspection",
				"responses": {
					"201": {
						"description": "Created"
					}
				},
				"description": "Schedules an inspection on a works.\n\nAccess: the user must have the HighwayAuthority role with the Compliance permission (401); the works must exist (404) and the user must have write access to it (401).\nValidation (400): see ScheduledInspectionCreateRequest in street-manager-client for field rules.\nBusiness constraints (412): the works must have a permit or be a Section 81 or historical works; the works must not already have a scheduled inspection; Section 81 works may only have a Section 81 inspection scheduled, and other works may not.\n\nSee business rules section 4.1.4 - Scheduling inspections",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ScheduledInspectionCreateRequest"
							}
						}
					}
				}
			}
		},
		"/authenticate": {
			"post": {
				"operationId": "Authenticate",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/AuthenticationResponse"
								}
							}
						}
					}
				},
				"description": "If authenticating for the first time with a temporary password, a 307 Temporary Redirect to `/authenticate/initial` will be returned,\nwhich can be called with the same request body.\n\nA sessionToken property may be returned from this redirect endpoint, which can be used to set a permanent password with the `/set-password`\nendpoint on the Party API.\n\nSee API specification Security section for more information.",
				"security": [],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/AuthenticationRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/fixed-penalty-notices/{fpnReferenceNumber}": {
			"get": {
				"operationId": "GetFPN",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FPNResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a fixed penalty notice on a works record.\nAccess: Planner, Contractor or HighwayAuthority role (401); the works record must exist (404); HighwayAuthority users may read any works, while Planner and Contractor users must have access to the works record's workstream and, for contractors, the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: the fixed penalty notice must exist and belong to the works record, otherwise 404 is returned.\nSee business rules section 11 - Fixed penalty notice (FPN)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "fpnReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			},
			"delete": {
				"operationId": "DeleteFPN",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Deletes a fixed penalty notice and its evidence files.\nAccess: HighwayAuthority role (401); the fixed penalty notice must exist and belong to the works record (404); the user's organisation must be the highway authority on the works record (401).\nBusiness constraints: none. A notice can be deleted from any status, including paid and withdrawn.\nSee business rules section 11 - Fixed penalty notice (FPN)",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "fpnReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/fixed-penalty-notices": {
			"post": {
				"operationId": "CreateFPN",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FPNCreateResponse"
								}
							}
						}
					}
				},
				"description": "Issues a fixed penalty notice against a works record.\nAccess: HighwayAuthority role (401); the works record must exist (404); the user's organisation must be the highway authority on the works record (401).\nBusiness constraints (412): every file_id must exist and must not already be linked to any other record in Street Manager; permit_reference_number, if supplied, must identify a permit on the same works record.\nSee business rules section 11 - Fixed penalty notice (FPN)",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/FPNCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/fixed-penalty-notices/{fpnReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateFPNStatus",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the status of a fixed penalty notice.\nAccess: Planner, Contractor or HighwayAuthority role (401); the fixed penalty notice must exist and belong to the works record (404); HighwayAuthority users must belong to the works record's highway authority organisation, while Planner and Contractor users must have full write access to the works record's workstream and, for contractors, the promoter organisation must not be suspended or disabled (401).\nBusiness constraints (412): a notice that is paid, paid_discounted or withdrawn cannot change. A HighwayAuthority can only move a notice to paid, paid_discounted or withdrawn. A Planner or Contractor can move an issued notice to accepted or disputed, and a disputed notice to accepted; they cannot change an accepted notice.\nSee business rules section 11.2 - FPN statuses",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "fpnReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/FPNStatusUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/comments": {
			"post": {
				"operationId": "PostComment",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/CommentCreateResponse"
								}
							}
						}
					}
				},
				"description": "Adds a comment to a works record.\nAccess: the works must exist (404). A Planner or Contractor must have full write access to the works' workstream, and a Contractor's promoter organisation must not be suspended or disabled; a HighwayAuthority must belong to (or be linked to) the works' highway authority organisation. Only a HighwayAuthority can post a comment with the OVERRUN topic (401).\nSee business rules section 7.1 - Commenting on a works record",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/CommentCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/comments/{commentReferenceNumber}/read": {
			"put": {
				"operationId": "MarkCommentAsRead",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Marks a comment as read.\nAccess: the comment must exist against the works (404). A Planner or Contractor must have full write access to the works' workstream, and a Contractor's promoter organisation must not be suspended or disabled; a HighwayAuthority must belong to (or be linked to) the works' highway authority organisation (401).\nBusiness constraints: the comment must not already be marked as read, and the user must not have access to the authoring organisation - only the recipient organisation can mark a comment as read (412).\nSee business rules section 7.1 - Commenting on a works record",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "commentReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/CommentReadRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/comments/{commentReferenceNumber}": {
			"get": {
				"operationId": "GetComment",
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/CommentResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a comment on a works record. The detail of an internal comment is replaced with the text 'Internal comment' unless the caller's organisation authored it.\nAccess: the comment must exist against the works (404). A HighwayAuthority has read access to all works; a Planner or Contractor must have read or write access to the works' workstream, and a Contractor's promoter organisation must not be suspended or disabled (401).\nSee business rules section 7.1 - Commenting on a works record",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "commentReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/duration": {
			"get": {
				"operationId": "CalculateDuration",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/DurationCalculationResponse"
								}
							}
						}
					}
				},
				"description": "Calculates the number of calendar days and working days between a start date and an end date, as would be assigned to a work or permit.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role.\n\nSee business rules section 1.2 - Dates and times\nSee glossary - Working day",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "startDate",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"in": "query",
						"name": "endDate",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/alterations/{permitAlterationReferenceNumber}": {
			"get": {
				"operationId": "GetPermitAlteration",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitAlterationResponse"
								}
							}
						}
					}
				},
				"description": "Deprecated. Returns a single permit alteration, including the original and proposed versions of the permit, by its reference number.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role (401 otherwise); no workstream or organisation ownership check is applied. Returns 404 if the permit does not exist, the alteration does not exist, or the alteration belongs to a different permit. The works reference number in the path is not used to look up the data. Reference numbers are matched regardless of letter case.\n\nSee business rules section 4 - Change requests (CR)",
				"deprecated": true,
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitAlterationReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/files": {
			"post": {
				"operationId": "AddFileToWork",
				"responses": {
					"201": {
						"description": "Created"
					}
				},
				"description": "Attaches previously uploaded files to a works record.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role (401 otherwise). The works must exist (404) and the user must have write access to it (401):\nPlanner/Contractor need write access to the works' workstream (a Contractor is also refused if the promoter organisation is suspended or disabled); HighwayAuthority users must belong to the works' highway authority organisation.\nBusiness constraints (400 for request validation failures, 412 Precondition Failed for the rules below, checked in this order):\n- file_ids must be an array of unique values with no null/undefined entries and at most 50 elements (400)\n- the works' existing file count plus the number of file_ids must not exceed 50 ('File limit reached')\n- every file_id must exist, and must not already be linked to an inspection, permit/permit alteration, change request, FPN, reinstatement, section 81, section 74, private street notice or material classification\n- no file_id may already be linked to a works\nReturns 201 on success. Each file is audited and the works' updated date is refreshed.\n\nSee API specification Resource Guide > Works API > File upload for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/AddFileToWorkRequest"
							}
						}
					}
				}
			}
		},
		"/activity": {
			"post": {
				"operationId": "CreateActivity",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ActivityCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates an activity (non-works event such as a skip, scaffold or event) on the highway.\n\nAccess: HighwayAuthority role with the Work permission (401 otherwise).\nBusiness constraints: when activity_coordinates is a point, it must contain only an easting and a northing, with no additional values such as elevation (412).\n\nSee business rules section 9 - Activities",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ActivityCreateRequest"
							}
						}
					}
				}
			}
		},
		"/activity/{activityReferenceNumber}": {
			"get": {
				"operationId": "GetActivity",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ActivityResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves an activity by its reference number, which is matched case-insensitively.\n\nAccess: Planner, Contractor or HighwayAuthority role (401 otherwise); no organisation restriction is applied, and cancelled activities are returned; the activity must exist (404 otherwise).\n\nSee business rules section 9 - Activities",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "activityReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			},
			"put": {
				"operationId": "UpdateActivity",
				"responses": {
					"204": {
						"description": "Altered"
					}
				},
				"description": "Updates an existing activity. The street and location of the activity cannot be changed.\n\nAccess: HighwayAuthority role with the Work permission (401 otherwise); the activity reference number must exist, matched case-insensitively (404 otherwise).\nBusiness constraints: the activity must not be cancelled; the activity's highway authority must be the user's own organisation or one of the additional organisations the user has access to (412).\n\nSee business rules section 9 - Activities",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "activityReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ActivityUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/activity/{activityReferenceNumber}/cancel": {
			"put": {
				"operationId": "CancelActivity",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Cancels an activity.\n\nAccess: HighwayAuthority role with the Work permission (401 otherwise); the activity reference number must exist, matched case-insensitively (404 otherwise).\nBusiness constraints: the activity must not already be cancelled; the activity's highway authority must be the user's own organisation or one of the additional organisations the user has access to (412).\n\nSee business rules section 9 - Activities",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "activityReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ActivityCancelRequest"
							}
						}
					}
				}
			}
		},
		"/forward-plans": {
			"post": {
				"operationId": "CreateForwardPlan",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ForwardPlanCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Creates a works record with a forward plan.\nAccess: Planner or Contractor role with permission to create works for the supplied promoter_swa_code and workstream_prefix (401); highway_authority_swa_code must belong to an organisation that exists and is not disabled (404); the USRN must be found in the NSG (404); work_reference_number, when supplied, must not already be in use (409).\nBusiness constraints: a point geometry supplied as works_coordinates must contain exactly two values; road_category must not be 9 (private street), must be supplied when the street is only partly private, and forward plans cannot be created on a fully private street; workstream_prefix, when supplied, must be a workstream of the promoter organisation. All return 412.\nSee business rules section 3.3 - Forward plans",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ForwardPlanCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/forward-plans/{forwardPlanReferenceNumber}": {
			"get": {
				"operationId": "GetForwardPlan",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ForwardPlanResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a forward plan on a works record.\nAccess: Planner, Contractor or HighwayAuthority role (401). No organisation or workstream restriction is applied, so any user holding one of these roles can read any forward plan.\nBusiness constraints: the works record must exist, the forward plan must exist, and the forward plan must belong to that works record, otherwise 404 is returned.\nSee business rules section 3.3 - Forward plans",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "forwardPlanReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			},
			"put": {
				"operationId": "UpdateForwardPlan",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates a forward plan.\nAccess: Planner or Contractor role (401); the forward plan must exist and belong to the works record (404); the user must have full write access to the works record's workstream, and for contractors the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: the forward plan must not already be cancelled or progressed (412).\nSee business rules section 3.3 - Forward plans",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "forwardPlanReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ForwardPlanUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/forward-plans/{forwardPlanReferenceNumber}/cancel": {
			"put": {
				"operationId": "CancelForwardPlan",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Cancels a forward plan and cancels the works record it belongs to.\nAccess: Planner or Contractor role (401); the forward plan must exist and belong to the works record (404); the user must have full write access to the works record's workstream, and for contractors the promoter organisation must not be suspended or disabled (401).\nBusiness constraints: the forward plan must not already be cancelled or progressed (412).\nSee business rules section 3.3 - Forward plans",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "forwardPlanReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ForwardPlanCancelRequest"
							}
						}
					}
				}
			}
		},
		"/section-81-works/section-81s": {
			"post": {
				"operationId": "CreateSection81",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section81CreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a Section 81 works record.\nAccess: HighwayAuthority role with the Compliance permission. highway_authority_swa_code must be an organisation the user can access (their own or a linked organisation); otherwise 401.\nBusiness constraints: promoter_swa_code must be an existing organisation that is not disabled (404). Field validation failures return 400. A point in works_coordinates must have only two values, and when section_81_evidence is true every file_id must exist and not already be associated with another record in Street Manager (412).\nAlso creates a works record for the Section 81, with audit records. A follow-up inspection is scheduled if reinspection_date is supplied.\nSee business rules section 4.4.3 - Adding S81s",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section81CreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/section-81s/{section81ReferenceNumber}": {
			"get": {
				"operationId": "GetSection81",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section81Response"
								}
							}
						}
					}
				},
				"description": "Retrieves a Section 81 on a works record.\nAccess: Planner, Contractor or HighwayAuthority role. The works must exist (404). Any HighwayAuthority user can read the works; a Planner or Contractor must have read access to the works' workstream in the promoter organisation, and a Contractor is also refused if that organisation is suspended or disabled (401).\nBusiness constraints: the Section 81 must exist and belong to the works in the URL, otherwise 404. Reference numbers are not case sensitive.\nSee business rules section 14 - Section 81 (S81)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section81ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/section-81s/{section81ReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateSection81Status",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the status of a Section 81.\nAccess: Planner, Contractor or HighwayAuthority role. The Section 81 must exist and belong to the works in the URL (404). The user must have write access to the works and the Compliance permission (a Contractor needs it on the promoter organisation's role), otherwise 401.\nBusiness constraints: section_81_status must be one of accepted, accepted_fixed, acknowledged, cancelled, rejected or resolved_by_ha, and valid for the user's role: HighwayAuthority may only set resolved_by_ha or cancelled; Planner or Contractor may only set acknowledged, accepted, accepted_fixed or rejected (400). status_reason (max 500 characters) is required for rejected, accepted_fixed, resolved_by_ha and cancelled; work_type is required for accepted (400). internal_user_identifier and internal_user_name are optional, max 100 characters (400).\nStatus transitions (412): a reassigned Section 81 cannot be updated; acknowledged only from issued; accepted only from issued, acknowledged or rejected; rejected only from issued, acknowledged or accepted; accepted_fixed only from accepted; resolved_by_ha or cancelled not from resolved_by_ha or cancelled. A Planner or Contractor accepting an unattributed works Section 81 must supply work_type permit_works (412).\nUpdates the status in a transaction with an audit record and updates the works' updated date. status_reason is stored as the promoter response for rejected and accepted_fixed only; work_type is stored for accepted only.\nSee business rules section 4.4 - Section 81 (S81) and section 14.5 - S81 statuses",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section81ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section81StatusUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/section-74s": {
			"post": {
				"operationId": "CreateSection74",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section74CreateResponse"
								}
							}
						}
					}
				},
				"description": "Issues a Section 74 overrun warning against a permit.\nAccess: HighwayAuthority role with the Compliance permission and write access to the works.\nBusiness constraints: the permit must exist on the works (404); the user must have write access to the works (401); the request body must pass field validation (400); the permit must not already have a Section 74 that has not been withdrawn (412); when section_74_evidence is true, file_ids must exist and not already be linked to another part of Street Manager (412).\nSee business rules section 20 - Section 74s",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section74CreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/section-74s/{section74ReferenceNumber}": {
			"get": {
				"operationId": "GetSection74",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section74Response"
								}
							}
						}
					}
				},
				"description": "Retrieves a Section 74. Invoice and charge details, and some additional details entered by the promoter or highway authority, are returned only to StreetWorksAdmin users (for a Contractor, only if they are a StreetWorksAdmin for the promoter organisation on the works).\nAccess: Planner, Contractor or HighwayAuthority role with read access to the works, restricted to the promoter or highway authority organisation on the works (401 otherwise).\nNot found (404): the works does not exist, or the Section 74 does not exist or does not belong to that works.\nThis endpoint only reads data. It does not change the Section 74 or create an audit record.\nSee business rules section 4.3 - Section 74 (S74)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section74ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/section-74s/{section74ReferenceNumber}/highway-authority-status": {
			"put": {
				"operationId": "UpdateSection74HAStatus",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the highway authority status of a Section 74 (charges ended, warning disputed, draft invoice issued, resolved or withdrawn) and records an audit event.\nAccess: HighwayAuthority role with the Compliance permission (401 otherwise); the Section 74 must exist on the works (404); the user must have write access to the works, meaning the highway authority organisation on the works is one they can access (401).\nBusiness constraints: the new status must be a valid transition from the current status (warning_issued to withdrawn, warning_disputed or charges_ended; charges_ended to withdrawn or draft_invoice_issued; warning_disputed to withdrawn or draft_invoice_issued; draft_invoice_issued to withdrawn or resolved); a resolved or withdrawn Section 74 cannot change (412).\nSee business rules section 20 - Section 74s",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section74ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section74UpdateHAStatusRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/section-74s/{section74ReferenceNumber}/promoter-status": {
			"put": {
				"operationId": "UpdateSection74PromoterStatus",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the promoter status of a Section 74 (acknowledged, site visited and rectified, disputed, draft invoice acknowledged, charge under review or charge agreed) and records an audit event.\nAccess: Planner or Contractor role with the Compliance permission (for a Contractor, held for the promoter organisation on the works) (401 otherwise); the Section 74 must exist on the works (404); the user must have write access to the works (401).\nBusiness constraints: the requested promoter status must be allowed from both the current promoter status and the current highway authority status (412).\nSee business rules section 20 - Section 74s",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section74ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section74UpdatePromoterStatusRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/final-reinstatement": {
			"put": {
				"operationId": "UpdateFinalReinstatement",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Records whether the reinstatements on a works are final.\n\nAccess: the user must have the Planner or Contractor role; the works must exist (404) and the user must have write access to it (401), which excludes Contractors when the promoter organisation is suspended or disabled.\nBusiness constraints (412): the works must have at least one site, and at least one of those sites must be an excavation site.\n\nSee business rules section 2.10.6 - Indicating when final site has been registered",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/FinalReinstatementUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/historic-works/fixed-penalty-notices": {
			"post": {
				"operationId": "CreateHistoricFPN",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/HistoricFPNCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a historical works record together with a fixed penalty notice (FPN) against it.\n\nAccess: the user must have the HighwayAuthority role and belong to the highway authority identified by highway_authority_swa_code; the promoter organisation identified by promoter_swa_code must exist and be active; historical_permit_reference must not already be used as a works reference number.\nBusiness constraints: works_coordinates must be a point, line string or polygon within the supported British National Grid bounds; when fpn_evidence is true every supplied file must exist and must not already be associated with another record.\n\nSee business rules section 4.6 - Historical works\nSee business rules section 4.2 - Fixed penalty notice (FPN)",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/HistoricFPNCreateRequest"
							}
						}
					}
				}
			}
		},
		"/non-notifiable-works/sites": {
			"post": {
				"operationId": "CreateNonNotifiableSite",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/NonNotifiableSiteCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a non-notifiable works record with a single reinstatement site (bar holes, core holes or pole testing).\n\nAccess: the user must have the Planner or Contractor role and be allowed to create works for promoter_swa_code (and have write access to workstream_prefix, if supplied; the default workstream cannot be used); the highway authority identified by highway_authority_swa_code must exist; work_reference_number, if supplied, must not already exist.\nBusiness constraints: workstream_prefix, if supplied, must be an existing workstream of the promoter; works and reinstatement coordinates must fall within the supported coordinate bounds and a point may contain only one coordinate pair; when reinstatement_evidence is true every supplied file must exist and must not already be associated with another record.\n\nSee business rules section 8 - Sites and reinstatements",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/NonNotifiableSiteCreateRequest"
							}
						}
					}
				}
			}
		},
		"/historic-works/inspections": {
			"post": {
				"operationId": "CreateHistoricInspection",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/HistoricInspectionCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a historical works record together with an inspection against it, in a single transaction.\n\nAccess: the user must have the HighwayAuthority role with the Compliance permission and belong to the highway authority identified by highway_authority_swa_code; the promoter organisation identified by promoter_swa_code must exist and not be disabled; historical_permit_reference must not already be used as a works reference number.\nBusiness constraints: works_coordinates must be a point, line string or polygon within the supported British National Grid bounds; when inspection_evidence is true every supplied file must exist and must not already be associated with another record; if any step fails nothing is saved.\n\nSee business rules section 4.6 - Historical works\nSee business rules section 4.1 - Inspections",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/HistoricInspectionCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/excavation-carried-out": {
			"put": {
				"operationId": "UpdateExcavationCarriedOut",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Records whether an excavation was actually carried out on the active permit.\n\nAccess: the user must have the Planner or Contractor role; the works must exist (404) and the user must have write access to the works (401). A Contractor is refused if the promoter organisation is suspended or disabled.\nBusiness constraints (412): the works must be in progress or completed; the active permit must have requested an excavation or already be marked as excavation carried out; no excavation sites may already be recorded against the active permit.\nValidation (400): `excavation_carried_out` must be a boolean and is required; `internal_user_identifier` and `internal_user_name` are optional, max 100 characters.\nSide effects: updates the permit, recalculates the reinstatement registration due date if the works have stopped, adds or reverts inspection units where criteria are met, and writes an audit record.\nSee the Street Manager business rules (Works), section 2.8.7 \"Updating excavation answer after works completed\".",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ExcavationCarriedOutUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/link-section-81": {
			"post": {
				"operationId": "LinkSection81ToPermit",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/LinkSection81ToPermitResponse"
								}
							}
						}
					}
				},
				"description": "Links a permit to a Section 81 so that the permit is recorded as the remedial works for that Section 81.\n\nAccess: the user must have the Planner or Contractor role; the permit and the Section 81 must both exist; the user must have write access to the works of both the permit and the Section 81.\nBusiness constraints: neither the permit nor the Section 81 may already be linked; the permit and the Section 81 must belong to the same highway authority and the same promoter.\n\nSee business rules section 14 - Section 81",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/LinkSection81ToPermitRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/unlink-section-81": {
			"post": {
				"operationId": "UnlinkSection81FromPermit",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Removes the link between a permit and a Section 81.\n\nAccess: the user must have the Planner or Contractor role; the permit and the Section 81 must both exist; the user must have write access to the works of both the permit and the Section 81.\nBusiness constraints: the permit and the Section 81 must currently be linked to each other.\n\nSee business rules section 14 - Section 81",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/UnlinkSection81FromPermitRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/section-81s/{section81ReferenceNumber}/reassign-section-81": {
			"put": {
				"operationId": "ReassignSection81",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReassignSection81Response"
								}
							}
						}
					}
				},
				"description": "Reassigns a cancelled or rejected Section 81 to a different promoter organisation by creating a new works record and a new Section 81 for that organisation, and marking the original Section 81 as reassigned.\n\nAccess: the user must have the HighwayAuthority role with the Compliance permission for the works and write access to the works; the Section 81 and the new organisation must both exist.\nBusiness constraints: the Section 81 must be cancelled or rejected; it must not be linked to a permit; the new organisation must be different from the current one.\n\nSee business rules section 14 - Section 81",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "section81ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ReassignSection81Request"
							}
						}
					}
				}
			}
		},
		"/section-58s": {
			"post": {
				"operationId": "CreateSection58",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section58CreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a Section 58 restriction in the proposed status.\nAccess: HighwayAuthority role with the Work permission; highway_authority_swa_code must identify the user's organisation or an organisation the user has access to (401 otherwise).\nSee business rules section 3.2 - Section 58",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section58CreateRequest"
							}
						}
					}
				}
			}
		},
		"/section-58s/{section58ReferenceNumber}": {
			"get": {
				"operationId": "GetSection58",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section58Response"
								}
							}
						}
					}
				},
				"description": "Retrieves a Section 58 by its reference number.\nAccess: Planner, Contractor or HighwayAuthority role. No permission, organisation or ownership check is applied.\nThe reference number is matched case-insensitively.\nBusiness constraints: 404 Not Found if no Section 58 exists with the given reference number.\nResponse: cancellation_reason is only returned when the Section 58 status is cancelled.\nSee business rules section 3.2.5 - Viewing Section 58 and section 22 - Section 58s",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "section58ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/section-58s/{section58ReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateSection58Status",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Updates the status of a Section 58 to in_force or cancelled; returns 204 No Content on success.\nAccess: HighwayAuthority role with the Work permission (401 otherwise); 404 Not Found if no Section 58 exists with the given reference number (checked before the request body is validated).\nBusiness constraints (412 Precondition Failed, after field validation): the user must have access to the organisation that raised the Section 58; closed and cancelled Section 58s cannot be changed; proposed can only move to in_force or cancelled; in_force can only move to cancelled.\nMoving to in_force sets the start date and recalculates the end date from the Section 58's restriction duration.\nSee business rules section 3.2.2 - Update Section 58 to 'in-force', section 3.2.3 - Cancelling Section 58 and section 22 - Section 58s",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "section58ReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/Section58UpdateStatusRequest"
							}
						}
					}
				}
			}
		},
		"/fee-matrix/{organisationReference}": {
			"get": {
				"operationId": "GetFeeMatrix",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FeeMatrixResponse"
								}
							}
						}
					}
				},
				"description": "Returns the permit fees and lane rental charge bands published by a highway authority.\n\nAccess: the user must hold the Planner, Contractor, Highway Authority or Admin role; the organisation reference must\nmatch an organisation that exists and is not disabled.\nBusiness constraints: the organisation must be a highway authority and must already have published a fee matrix.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority",
							"Admin"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "organisationReference",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/ancillary-informations": {
			"post": {
				"operationId": "CreateAncillaryInfo",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/CreateAncillaryInfoResponse"
								}
							}
						}
					}
				},
				"description": "Adds ancillary information (e.g. welfare units, material storage) to a permit.\n\nAccess: Planner or Contractor role. The permit must exist for the given works, otherwise 404. The user must have write access to the works: planners and contractors must have write access to the works' workstream and, for contractors, the promoter organisation must not be suspended or disabled; otherwise 401.\n\nBusiness constraints: each point in ancillary_info_coordinates must have no more than two coordinate values (412); a permit can have no more than 20 ancillary informations (412); every supplied USRN must be found in the street lookup service, otherwise 404 listing the USRNs that could not be found.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/CreateAncillaryInfoRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/ancillary-informations/{ancillaryInformationReferenceNumber}/remove": {
			"put": {
				"operationId": "RemoveAncillaryInfo",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/RemoveAncillaryInfoResponse"
								}
							}
						}
					},
					"412": {
						"description": "Precondition Failed"
					}
				},
				"description": "Marks an ancillary information on a permit as removed, recording the reason for removal.\n\nAccess: Planner or Contractor role. The ancillary information must exist, the permit must exist and the ancillary information must belong to that permit for the given works, otherwise 404. The user must have write access to the works: planners and contractors must have write access to the works' workstream and, for contractors, the promoter organisation must not be suspended or disabled; otherwise 401.\n\nBusiness constraints: the ancillary information must not already be removed (412).",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "ancillaryInformationReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/RemoveAncillaryInfoRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/ancillary-informations/{ancillaryInformationReferenceNumber}": {
			"get": {
				"operationId": "GetAncillaryInfo",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/AncillaryInfoResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a single ancillary information record on a permit, including removed records.\n\nAccess: Planner, Contractor or HighwayAuthority role. The permit must exist, the ancillary information must exist and the ancillary information must belong to that permit for the given works, otherwise 404. No workstream or organisation restriction is applied, so any user holding one of these roles can read any ancillary information.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "ancillaryInformationReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/non-compliances/{nonComplianceReferenceNumber}": {
			"get": {
				"operationId": "GetNonCompliance",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/NonComplianceResponse"
								}
							}
						}
					}
				},
				"description": "Returns a single non-compliance on a works.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role; the works must exist (otherwise not found is returned); highway authority users can read any works, while planner and contractor users need read access to the works' workstream and a contractor's organisation must not be suspended or disabled (otherwise unauthorised is returned); returns not found if the non-compliance does not exist or belongs to a different works. Both reference numbers are matched case-insensitively.\n\nSee business rules section 10 - Inspections and non-compliance",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "nonComplianceReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/non-compliances/{nonComplianceReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateNonComplianceStatus",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Records a response to a non-compliance, such as suggesting a joint site meeting, accepting a suggestion, confirming attendance, declaring the works ready for reinspection, or withdrawing the non-compliance.\n\nAccess: user must have the Planner, Contractor or HighwayAuthority role with the Compliance permission for the works. The works and non-compliance must exist (otherwise 404). The user must have write access to the works (otherwise 401): Planner and Contractor users need full write access to the works' workstream and a Contractor's promoter organisation must not be suspended or disabled; Highway Authority users must belong to the highway authority organisation on the works.\nBusiness constraints: the response status must be one permitted for the user's role, with response details and a suggested date supplied where the status requires them (otherwise 400). The non-compliance must belong to the works, must not be resolved or withdrawn, and must not be awaiting reinspection (otherwise 412). Further 412 rules apply to accepting a suggestion, confirming attendance and \"joint site meeting not needed\". Withdrawing also withdraws the linked inspections that are not already withdrawn.\n\nSee business rules section 4.7 - Non-Compliance",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "nonComplianceReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/NonComplianceResponseStatusRequest"
							}
						}
					}
				}
			}
		},
		"/private-street-notices": {
			"post": {
				"operationId": "CreatePrivateStreetNotice",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PrivateStreetNoticeCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Creates a works record with a private street notice.\nAccess: Planner or Contractor role. The user must have permission to create works for promoter_swa_code, and write access to workstream_prefix (the default workstream 000 cannot be used) if supplied, otherwise write access to at least one non-default workstream (401). highway_authority_swa_code must belong to an existing, enabled organisation (404).\nBusiness constraints: work_reference_number, if supplied, must not already exist (409). The USRN must be found in the NSG (404). road_category, if supplied, must be 9 (private street) and the street must be fully or partially private; if road_category is omitted the street must be fully private (412). A works_coordinates point must have a single coordinate pair (412). file_ids must exist and must not already be linked to another record (412). workstream_prefix, if supplied, must exist for the promoter (412).\nSee business rules section 2.11 - Private Streets",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PrivateStreetNoticeCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/private-street-notices/{privateStreetReferenceNumber}": {
			"get": {
				"operationId": "GetPrivateStreetNotice",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PrivateStreetNoticeResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a private street notice on a works record.\nAccess: Planner, Contractor or HighwayAuthority role. HighwayAuthority users can read any works record. Planner and Contractor users need read access (any access level) to the works record's workstream, and a Contractor is refused if the promoter organisation is suspended or disabled (401). Works record must exist (404).\nBusiness constraints: the private street notice must exist and belong to the works record in the URL (404). Both reference numbers are case-insensitive.\nSee business rules section 2.11 - Private Streets",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					},
					{
						"in": "path",
						"name": "privateStreetReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/private-street-notices/{privateStreetReferenceNumber}/cancel": {
			"put": {
				"operationId": "CancelPrivateStreetNotice",
				"responses": {
					"204": {
						"description": "No content"
					}
				},
				"description": "Cancels a private street notice and sets the status of its works record to cancelled.\nAccess: Planner or Contractor role. The user must have read access (any access level) to the works record's workstream, and a Contractor is refused if the promoter organisation is suspended or disabled (401). The works record and the private street notice must both exist (404).\nBusiness constraints: cancellation_reason is required and must be 500 characters or less (400). The private street notice must have a status of issued; a notice that is already cancelled cannot be cancelled again (412). Both reference numbers are case-insensitive.\nSee business rules section 2.11.4 - Cancelling works",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					},
					{
						"in": "path",
						"name": "privateStreetReferenceNumber",
						"required": true,
						"schema": {
							"type": "string",
							"maxLength": 100
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/PrivateStreetNoticeCancelRequest"
							}
						}
					}
				}
			}
		},
		"/material-classifications": {
			"post": {
				"operationId": "CreateMaterialsClassification",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/MaterialClassificationCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Records a material classification (sample result) at a location on a street.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role.\nBusiness constraints: the file, if supplied, must exist and must not already be associated with another record; the coordinates must be a point with a single easting and northing pair; the USRN must exist in the street gazetteer and the highway authority must exist (otherwise not found).",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/MaterialClassificationCreateRequest"
							}
						}
					}
				}
			}
		},
		"/material-classifications/{materialClassificationReferenceNumber}": {
			"get": {
				"operationId": "GetMaterialClassification",
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/MaterialClassificationResponse"
								}
							}
						}
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Returns a single material classification by its reference number.\n\nAccess: the user must have the Planner, Contractor or HighwayAuthority role; there is no ownership or organisation restriction on which material classifications can be read. Returns not found if no material classification matches the reference number (matching ignores letter case).",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "materialClassificationReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests": {
			"post": {
				"operationId": "CreateChangeRequest",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ChangeRequestCreateResponse"
								}
							}
						}
					},
					"409": {
						"description": "Conflict"
					}
				},
				"description": "Creates a change request against a permit. Depending on the permit state the change is applied immediately (promoter imposed change, modified permit, HS2 highway works or works inside HS2 act limits) or left submitted for assessment (promoter change request, works extension).\n\nAccess: Planner or Contractor role with write access to the works; the permit must exist on the named works (404).\nBusiness constraints: at least one field other than change_request_reason must be supplied (400); only supplied fields are validated (400); no other change request may be awaiting assessment (412); the permit must be granted, a permit modification request, or an active in-progress permit (412); a PAA cannot be changed (412); proposed start date/time cannot change once works are in progress (412); a planned minor/standard permit cannot become major/PAA (412); a promoter imposed change cannot alter work_type (412); primary_promoter_permit_reference_number must be valid for the collaboration state and reference an existing permit (412); file_ids must pass the file attachment checks (412).\n\nSee business rules section 2.5 - Change requests",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ChangeRequestCreateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests/{changeRequestReferenceNumber}/status": {
			"put": {
				"operationId": "UpdateChangeRequestStatus",
				"responses": {
					"204": {
						"description": "No Content"
					}
				},
				"description": "Assesses (grants, refuses or grants with duration challenge) a change request awaiting assessment. Granting applies the proposed values to the permit as a new permit version.\n\nAccess: HighwayAuthority role with write access to the works; the permit must exist on the named works and the change request must exist (404).\nBusiness constraints: the change request must not be an HA-imposed, promoter-imposed or permit modification change, and must still be awaiting assessment; only a works extension can be granted with duration challenge (412).\n\nSee business rules section 2.5 - Change requests",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "changeRequestReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ChangeRequestStatusUpdateRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests/{changeRequestReferenceNumber}": {
			"get": {
				"operationId": "GetChangeRequest",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ChangeRequestResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a change request on a permit, returning the permit as it stood when the change request was raised alongside the fields the change request proposes to alter.\n\nAccess: Planner, Contractor or HighwayAuthority role with read access to the works. Any highway authority user may read; a promoter user must have read access to the workstream the works belong to, and contractors are denied where the promoter organisation is suspended or disabled. The permit must exist on the named works, and the change request must exist and belong to that permit (404).\n\nSee business rules section 4 - Change requests (CR)",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "changeRequestReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				]
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests/{changeRequestReferenceNumber}/duration-challenge-review": {
			"put": {
				"operationId": "DurationChallengeReview",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records the promoter's response to a change request that the highway authority granted with a duration challenge, either accepting the shortened reasonable period or setting out why it is not accepted.\n\nAccess: Planner or Contractor role with write access to the works; the permit must exist on the named works and the change request must exist and belong to that permit (404).\nBusiness constraints: the permit must still be active, meaning it has no actual end date and is not closed; the change request must have been granted with a duration challenge; the duration challenge review process must not already be complete; and where a review has already been recorded, the highway authority must have responded to it before another can be submitted (412).\n\nSee business rules section 21.1 - Duration challenge review",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "changeRequestReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ChangeRequestDurationChallengeReviewRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests/{changeRequestReferenceNumber}/duration-challenge-non-acceptance-response": {
			"put": {
				"operationId": "DurationChallengeNonAcceptanceResponse",
				"responses": {
					"204": {
						"description": "No Content"
					},
					"404": {
						"description": "Not Found"
					}
				},
				"description": "Records the highway authority's response after a promoter has declined a change request duration challenge, either setting a revised reasonable period end date or explaining why the existing one stands.\n\nAccess: HighwayAuthority role with write access to the works; the permit must exist on the named works and the change request must exist and belong to that permit (404).\nBusiness constraints: the permit must still be active, meaning it has no actual end date and is not closed; the change request must have been granted with a duration challenge and the promoter must have recorded that they do not accept it; and a response must not already have been given (412).\n\nSee business rules section 21.2 - Duration challenge non acceptance response",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "changeRequestReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ChangeRequestDurationChallengeNonAcceptanceResponseRequest"
							}
						}
					}
				}
			}
		},
		"/works/{workReferenceNumber}/permits/{permitReferenceNumber}/change-requests/impose": {
			"post": {
				"operationId": "ImposeChangeRequest",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ChangeRequestImposeChangeResponse"
								}
							}
						}
					}
				},
				"description": "Imposes a change to the conditions of a granted permit, recording an already-granted change request and making the amended permit the current version.\n\nAccess: requires the HighwayAuthority role and write access to the works; returns not found if the permit does not exist on the works; the submitted conditions must differ from the conditions currently held on the permit.\nBusiness constraints: permit conditions must be supplied; the permit must have no change request awaiting assessment; the permit must not be a PAA; the permit must be granted; the permit must not be HS2 highway works and must not be an HS2 consultation.\n\nSee business rules section 4 - Change requests (CR)",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "workReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"in": "path",
						"name": "permitReferenceNumber",
						"required": true,
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ChangeRequestImposeChangeRequest"
							}
						}
					}
				}
			}
		},
		"/files": {
			"post": {
				"operationId": "UploadFile",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryResponse"
								}
							}
						}
					}
				},
				"description": "Uploads a file (multipart/form-data) so it can later be linked to a works, permit, inspection or other record.\n\nAccess: Planner, Contractor, HighwayAuthority or Admin role. A Contractor must supply a swaCode for an organisation\nthat has a contract with their own organisation and that is not suspended or disabled; otherwise 401. For all other\nroles the swaCode is ignored and the file is recorded against the user's own organisation.\n\nA file must be supplied in the file form field and must be a doc, docx, pdf, png, jpeg, jpg, tiff or bmp with a\nmatching content type, a file name of 100 characters or less, and a size of 10MB or less; otherwise 400.\n\nSee API specification Resource Guide > Works API > File upload for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority",
							"Admin"
						]
					}
				],
				"parameters": [
					{
						"in": "query",
						"name": "swaCode",
						"schema": {
							"type": "string"
						}
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"multipart/form-data": {
							"schema": {
								"type": "object",
								"properties": {
									"file": {
										"type": "string",
										"format": "binary"
									}
								}
							}
						}
					}
				}
			}
		},
		"/files/{fileId}": {
			"delete": {
				"operationId": "DeleteFile",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Permanently deletes an uploaded file.\n\nAccess: Planner, Contractor, HighwayAuthority or Admin role (401). The file must exist (404). The user must belong\nto the organisation the file was recorded against; a Contractor must additionally have a contract with that\norganisation and that organisation must not be suspended or disabled (401).\n\nBusiness constraints: the file must not be linked to an inspection, reinstatement, permit or permit alteration,\nFPN, geographical area, works, Section 81, Section 74, private street notice, material classification or change\nrequest (412).\n\nSee API specification Resource Guide > Works API > File upload for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority",
							"Admin"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "fileId",
						"required": true,
						"schema": {
							"format": "double",
							"type": "number"
						}
					}
				]
			},
			"get": {
				"operationId": "GetFile",
				"description": "Downloads a file as an attachment.\n\nAccess: Planner, Contractor, HighwayAuthority or Admin role (401). A file linked to a material classification is\nreadable by any authenticated user. A file linked to a geographical area is readable only by users of the owning\nhighway authority organisation. Any other file is readable by any highway authority user; for promoter users the\nfile must be linked to a works, permit, inspection, reinstatement, FPN, Section 74, Section 81 or private street\nnotice whose workstream they have read access to, and their organisation must not be suspended or disabled. If the\nfile is not linked to any record, the user's organisation must be the one that uploaded it (401).\n\nOnly files that have passed virus scanning and are still present in storage can be downloaded; otherwise 404.\n\nSee API specification Resource Guide > Works API > File upload for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority",
							"Admin"
						]
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/vnd.msword": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							},
							"application/pdf": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							},
							"image/png": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							},
							"image/jpeg": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							},
							"image/tiff": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							},
							"image/bmp": {
								"schema": {
									"type": "string",
									"format": "binary"
								}
							}
						}
					},
					"204": {
						"description": "No content"
					}
				},
				"parameters": [
					{
						"in": "path",
						"name": "fileId",
						"schema": {
							"type": "integer"
						},
						"required": true
					}
				]
			}
		},
		"/geographical-areas": {
			"post": {
				"operationId": "CreateGeographicalArea",
				"responses": {
					"201": {
						"description": "Created",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/GeographicalAreaCreateResponse"
								}
							}
						}
					}
				},
				"description": "Creates a geographical area for the user's highway authority from an uploaded file of USRNs.\n\nAccess: the user must have the HighwayAuthority or Admin role.\nBusiness constraints: your organisation and any additional organisations linked to your account must have fewer than 100 geographical areas in total (otherwise precondition failed); the upload must be a CSV file with a single column of unique USRNs, at least 1 and at most 10,000, each between 100001 and 99999999 (otherwise bad request).\n\nSee API specification Resource Guide > Works API > Geographical Areas for more information",
				"security": [
					{
						"token": [
							"Admin",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [],
				"requestBody": {
					"required": true,
					"content": {
						"multipart/form-data": {
							"schema": {
								"type": "object",
								"properties": {
									"file": {
										"type": "string",
										"format": "binary"
									},
									"internalUserIdentifier": {
										"type": "string"
									},
									"internalUserName": {
										"type": "string"
									}
								}
							}
						}
					}
				}
			}
		},
		"/geographical-areas/{geographicalAreaReferenceNumber}": {
			"put": {
				"operationId": "UpdateGeographicalArea",
				"responses": {
					"204": {
						"description": ""
					}
				},
				"description": "Replaces the USRNs of an existing geographical area from an uploaded file.\n\nAccess: the user must have the HighwayAuthority or Admin role.\nBusiness constraints: the geographical area must belong to your organisation or an additional organisation linked to your account (otherwise precondition failed); the upload must be a CSV file with a single column of unique USRNs, at least 1 and at most 10,000, each between 100001 and 99999999 (otherwise bad request).\n\nSee API specification Resource Guide > Works API > Geographical Areas for more information",
				"security": [
					{
						"token": [
							"Admin",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"in": "path",
						"name": "geographicalAreaReferenceNumber",
						"schema": {
							"type": "string"
						},
						"required": true
					}
				],
				"requestBody": {
					"required": true,
					"content": {
						"multipart/form-data": {
							"schema": {
								"type": "object",
								"properties": {
									"file": {
										"type": "string",
										"format": "binary"
									},
									"geographicalAreaReferenceNumber": {
										"type": "string"
									},
									"internalUserIdentifier": {
										"type": "string"
									},
									"internalUserName": {
										"type": "string"
									}
								}
							}
						}
					}
				}
			}
		}
	}
}