{
	"openapi": "3.0.0",
	"components": {
		"examples": {},
		"headers": {},
		"parameters": {},
		"requestBodies": {},
		"responses": {},
		"schemas": {
			"ActivityActivityTypeResponse": {
				"enum": [
					"skips",
					"scaffolding",
					"hoarding",
					"crane_mobile_platform",
					"event",
					"section50",
					"section58",
					"compound",
					"other",
					"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"
			},
			"ActivitySummaryResponse": {
				"properties": {
					"activity_reference_number": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"street_name": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area_name": {
						"type": "string"
					},
					"road_category": {
						"type": "number",
						"format": "double"
					},
					"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"
					},
					"contact_details": {
						"type": "string"
					},
					"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
					},
					"activity_location_description": {
						"type": "string"
					},
					"traffic_management_required": {
						"type": "boolean"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"collaborative_working": {
						"type": "boolean"
					},
					"additional_info": {
						"type": "string"
					},
					"cancelled": {
						"type": "boolean"
					},
					"cancelled_reason": {
						"type": "string",
						"nullable": true
					},
					"ha_organisation_name": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"activity_reference_number",
					"usrn",
					"street_name",
					"town",
					"area_name",
					"road_category",
					"activity_coordinates",
					"activity_name",
					"activity_activity_type",
					"activity_activity_type_string",
					"contact_name",
					"contact_details",
					"start_date",
					"end_date",
					"activity_location_description",
					"traffic_management_required",
					"traffic_management_type",
					"traffic_management_type_string",
					"collaborative_working",
					"additional_info",
					"cancelled",
					"ha_organisation_name",
					"date_created"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PaginationResponse": {
				"properties": {
					"total_rows": {
						"type": "number",
						"format": "double",
						"nullable": true
					},
					"has_next_page": {
						"type": "boolean"
					}
				},
				"required": [
					"total_rows",
					"has_next_page"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ActivitySummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ActivityActivityType": {
				"enum": [
					"skips",
					"scaffolding",
					"hoarding",
					"crane_mobile_platform",
					"event",
					"section50",
					"section58",
					"compound",
					"other"
				],
				"type": "string"
			},
			"ActivitySortColumn": {
				"enum": [
					"date_created"
				],
				"type": "string"
			},
			"SortDirection": {
				"enum": [
					"asc",
					"desc"
				],
				"type": "string"
			},
			"WorkStatusResponse": {
				"enum": [
					"planned",
					"in_progress",
					"completed",
					"cancelled",
					"unattributable",
					"historical",
					"non_notifiable",
					"section_81",
					"upcoming_enum"
				],
				"type": "string"
			},
			"WorkCategoryResponse": {
				"enum": [
					"minor",
					"standard",
					"major",
					"immediate_urgent",
					"immediate_emergency",
					"paa",
					"hs2_highway",
					"upcoming_enum"
				],
				"type": "string"
			},
			"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"
			},
			"LaneRentalAssessmentOutcomeResponse": {
				"enum": [
					"chargeable",
					"potentially_chargeable",
					"charges_waived",
					"exempt",
					"charges_not_applicable",
					"upcoming_enum"
				],
				"type": "string"
			},
			"AlterationSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"alteration_reference_number": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"promoter": {
						"type": "string"
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponse"
					},
					"work_category_string": {
						"type": "string"
					},
					"alteration_status": {
						"$ref": "#/components/schemas/AlterationStatusResponse"
					},
					"alteration_status_string": {
						"type": "string"
					},
					"alteration_type": {
						"$ref": "#/components/schemas/AlterationTypeResponse"
					},
					"alteration_type_string": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"lane_rental_assessment_outcome": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LaneRentalAssessmentOutcomeResponse"
							}
						],
						"nullable": true
					},
					"lane_rental_assessment_outcome_string": {
						"type": "string",
						"nullable": true
					},
					"lane_rental_charges_not_agreed": {
						"type": "boolean"
					},
					"lane_rental_charges_potentially_apply": {
						"type": "boolean"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"alteration_reference_number",
					"street",
					"town",
					"area",
					"location_description",
					"highway_authority",
					"promoter",
					"work_status",
					"work_status_string",
					"proposed_start_date",
					"proposed_end_date",
					"work_category",
					"work_category_string",
					"alteration_status",
					"alteration_status_string",
					"alteration_type",
					"alteration_type_string",
					"date_created",
					"deadline_date",
					"status_changed_date",
					"lane_rental_charges_not_agreed",
					"lane_rental_charges_potentially_apply"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AlterationReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/AlterationSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AlterationStatus": {
				"enum": [
					"submitted",
					"granted",
					"granted_with_duration_challenge",
					"refused",
					"deemed",
					"cancelled",
					"revoked",
					"auto_applied"
				],
				"type": "string"
			},
			"AlterationType": {
				"enum": [
					"PROMOTER_IMPOSED_CHANGE",
					"PROMOTER_CHANGE_REQUEST",
					"HA_CHANGE_REQUEST",
					"HA_IMPOSED_CHANGE",
					"WORK_EXTENSION",
					"DURATION_CHALLENGE",
					"MODIFIED_PERMIT"
				],
				"type": "string"
			},
			"WorkStatus": {
				"enum": [
					"planned",
					"in_progress",
					"completed",
					"cancelled",
					"unattributable",
					"historical",
					"non_notifiable",
					"section_81"
				],
				"type": "string"
			},
			"WorkCategory": {
				"enum": [
					"minor",
					"standard",
					"major",
					"immediate_urgent",
					"immediate_emergency",
					"paa",
					"hs2_highway"
				],
				"type": "string"
			},
			"LaneRentalAssessmentOutcome": {
				"enum": [
					"chargeable",
					"potentially_chargeable",
					"charges_waived",
					"exempt",
					"charges_not_applicable"
				],
				"type": "string"
			},
			"AlterationSortColumn": {
				"enum": [
					"date_created",
					"proposed_start_date",
					"proposed_end_date",
					"status_changed_date"
				],
				"type": "string"
			},
			"DurationChallengeReviewStatusResponse": {
				"enum": [
					"duration_challenge_accepted",
					"duration_challenge_not_accepted",
					"no_response",
					"upcoming_enum"
				],
				"type": "string"
			},
			"DurationChallengeNonAcceptanceResponseStatusResponse": {
				"enum": [
					"reasonable_period_end_date_changed",
					"reasonable_period_end_date_not_changed",
					"no_response",
					"upcoming_enum"
				],
				"type": "string"
			},
			"AlterationDurationChallengeSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"alteration_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status_string": {
						"type": "string"
					},
					"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"
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"alteration_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"usrn",
					"promoter_swa_code",
					"promoter_organisation",
					"highway_authority",
					"proposed_start_date",
					"proposed_end_date",
					"reasonable_period_end_date",
					"status_changed_date",
					"work_status",
					"work_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AlterationDurationChallengeReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/AlterationDurationChallengeSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AlterationDurationChallengeSortColumn": {
				"enum": [
					"status_changed_date"
				],
				"type": "string"
			},
			"DurationChallengeReviewStatus": {
				"enum": [
					"duration_challenge_accepted",
					"duration_challenge_not_accepted",
					"no_response"
				],
				"type": "string"
			},
			"DurationChallengeNonAcceptanceResponseStatus": {
				"enum": [
					"reasonable_period_end_date_changed",
					"reasonable_period_end_date_not_changed",
					"no_response"
				],
				"type": "string"
			},
			"AssessmentStatusResponse": {
				"enum": [
					"granted",
					"granted_auto",
					"refused",
					"refused_auto",
					"permit_modification_request",
					"revoked",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitStatusResponse": {
				"enum": [
					"submitted",
					"granted",
					"permit_modification_request",
					"refused",
					"closed",
					"cancelled",
					"revoked",
					"progressed",
					"upcoming_enum",
					"under_assessment"
				],
				"type": "string"
			},
			"PermitConditionTypeResponse": {
				"enum": [
					"NCT01a",
					"NCT01b",
					"NCT02a",
					"NCT02b",
					"NCT04a",
					"NCT04b",
					"NCT05a",
					"NCT06a",
					"NCT07a",
					"NCT08a",
					"NCT08b",
					"NCT09a",
					"NCT09b",
					"NCT09c",
					"NCT10a",
					"NCT11a",
					"NCT11b",
					"NCT12a",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermitCondition": {
				"properties": {
					"condition": {
						"$ref": "#/components/schemas/PermitConditionTypeResponse"
					},
					"condition_string": {
						"type": "string"
					},
					"comment": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"condition",
					"condition_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"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"
			},
			"PermitSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"works_coordinates": {},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponse"
					},
					"work_category_string": {
						"type": "string"
					},
					"description_of_work": {
						"type": "string"
					},
					"traffic_management_type": {
						"$ref": "#/components/schemas/TrafficManagementTypeResponse"
					},
					"traffic_management_type_string": {
						"type": "string"
					},
					"assessment_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/AssessmentStatusResponse"
							}
						],
						"nullable": true
					},
					"assessment_status_string": {
						"type": "string",
						"nullable": true
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"status": {
						"$ref": "#/components/schemas/PermitStatusResponse"
					},
					"status_string": {
						"type": "string"
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"is_active_permit": {
						"type": "boolean"
					},
					"permit_conditions": {
						"items": {
							"$ref": "#/components/schemas/PermitCondition"
						},
						"type": "array",
						"nullable": true
					},
					"road_category": {
						"type": "number",
						"format": "double"
					},
					"is_traffic_sensitive": {
						"type": "boolean"
					},
					"has_no_final_reinstatement": {
						"type": "boolean"
					},
					"is_deemed": {
						"type": "boolean"
					},
					"excavation_carried_out": {
						"type": "boolean"
					},
					"is_early_start": {
						"type": "boolean"
					},
					"is_high_impact_traffic_management": {
						"type": "boolean"
					},
					"is_lane_rental": {
						"type": "boolean"
					},
					"lane_rental_assessment_outcome": {
						"allOf": [
							{
								"$ref": "#/components/schemas/LaneRentalAssessmentOutcomeResponse"
							}
						],
						"nullable": true
					},
					"lane_rental_assessment_outcome_string": {
						"type": "string",
						"nullable": true
					},
					"lane_rental_charges_not_agreed": {
						"type": "boolean"
					},
					"lane_rental_charges_potentially_apply": {
						"type": "boolean"
					},
					"paa_to_pa_deadline_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"activity_type": {
						"$ref": "#/components/schemas/ActivityTypeResponse"
					},
					"activity_type_string": {
						"type": "string"
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"promoter_swa_code",
					"promoter_organisation",
					"highway_authority",
					"works_coordinates",
					"location_description",
					"street",
					"town",
					"area",
					"work_category",
					"work_category_string",
					"description_of_work",
					"traffic_management_type",
					"traffic_management_type_string",
					"proposed_start_date",
					"proposed_end_date",
					"status",
					"status_string",
					"work_status",
					"work_status_string",
					"deadline_date",
					"date_created",
					"status_changed_date",
					"usrn",
					"is_active_permit",
					"road_category",
					"is_traffic_sensitive",
					"has_no_final_reinstatement",
					"is_deemed",
					"excavation_carried_out",
					"is_early_start",
					"is_high_impact_traffic_management",
					"is_lane_rental",
					"lane_rental_charges_not_agreed",
					"lane_rental_charges_potentially_apply",
					"activity_type",
					"activity_type_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PermitSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitStatus": {
				"enum": [
					"submitted",
					"granted",
					"permit_modification_request",
					"refused",
					"closed",
					"cancelled",
					"revoked",
					"progressed",
					"under_assessment"
				],
				"type": "string"
			},
			"PermitSortColumn": {
				"enum": [
					"date_created",
					"deadline_date",
					"end_date",
					"start_date",
					"status_changed_date",
					"reasonable_period_end_date"
				],
				"type": "string"
			},
			"PermitDurationChallengeSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"assessment_status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status_string": {
						"type": "string"
					},
					"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"
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"usrn",
					"promoter_swa_code",
					"promoter_organisation",
					"highway_authority",
					"proposed_start_date",
					"proposed_end_date",
					"reasonable_period_end_date",
					"assessment_status_changed_date",
					"work_status",
					"work_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitDurationChallengeReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PermitDurationChallengeSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PermitDurationChallengeSortColumn": {
				"enum": [
					"assessment_status_changed_date"
				],
				"type": "string"
			},
			"ReinstatementsDueSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"organisation_name": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"work_stopped_date": {
						"type": "string",
						"format": "date-time"
					},
					"registration_due_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"organisation_name",
					"street",
					"town",
					"area",
					"work_stopped_date",
					"registration_due_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementsDueReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ReinstatementsDueSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FileSummaryResponse": {
				"properties": {
					"file_id": {
						"type": "number",
						"format": "double"
					},
					"name": {
						"type": "string"
					}
				},
				"required": [
					"file_id",
					"name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FileSummaryReportingResponse": {
				"properties": {
					"rows": {
						"items": {
							"$ref": "#/components/schemas/FileSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FileType": {
				"enum": [
					"images",
					"documents"
				],
				"type": "string"
			},
			"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"
					},
					"work_reference_number": {
						"type": "string"
					},
					"promoter": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"offence_code": {
						"$ref": "#/components/schemas/OffenceCodeResponse"
					},
					"offence_code_string": {
						"type": "string"
					},
					"street_name": {
						"type": "string"
					},
					"issue_date": {
						"type": "string",
						"format": "date-time"
					},
					"status": {
						"$ref": "#/components/schemas/FPNStatusResponse"
					},
					"status_string": {
						"type": "string"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"fpn_reference_number",
					"work_reference_number",
					"promoter",
					"highway_authority",
					"offence_code",
					"offence_code_string",
					"street_name",
					"issue_date",
					"status",
					"status_string",
					"status_changed_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FPNReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/FPNSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"FPNStatus": {
				"enum": [
					"issued",
					"accepted",
					"paid",
					"paid_discounted",
					"disputed",
					"withdrawn"
				],
				"type": "string"
			},
			"OffenceCode": {
				"enum": [
					"offence_code_05",
					"offence_code_06",
					"offence_code_08",
					"offence_code_09"
				],
				"type": "string"
			},
			"FPNSortColumn": {
				"enum": [
					"issue_date_time",
					"status_changed_date"
				],
				"type": "string"
			},
			"CommentTopicResponse": {
				"enum": [
					"GENERAL",
					"SECTION_74",
					"INSPECTION",
					"FPN",
					"OVERRUN",
					"FORWARD_PLAN",
					"CHANGE_REQUEST",
					"IMPOSED_VARIATION",
					"DURATION_CHALLENGE",
					"SECTION_81",
					"UNATTRIBUTED_WORKS",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CommentSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"topic": {
						"$ref": "#/components/schemas/CommentTopicResponse"
					},
					"topic_string": {
						"type": "string"
					},
					"author_email_address": {
						"type": "string"
					},
					"author_organisation_reference": {
						"type": "string"
					},
					"detail": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"comment_reference_number": {
						"type": "string"
					},
					"is_read": {
						"type": "boolean"
					},
					"read_on": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"read_by": {
						"type": "string",
						"nullable": true
					},
					"is_internal": {
						"type": "boolean"
					}
				},
				"required": [
					"work_reference_number",
					"topic",
					"topic_string",
					"author_email_address",
					"author_organisation_reference",
					"detail",
					"date_created",
					"comment_reference_number",
					"is_read",
					"is_internal"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CommentReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/CommentSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"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"
			},
			"InspectionTypeResponse": {
				"enum": [
					"live_site",
					"reinstatement",
					"non_compliance_follow_up",
					"section_81",
					"investigatory_works",
					"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",
					"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"
			},
			"InspectionStatusResponse": {
				"enum": [
					"recorded",
					"withdrawn",
					"scheduled",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionOutcomeStatusTypeResponse": {
				"enum": [
					"inspection_outcome_accepted",
					"inspection_outcome_disputed",
					"inspection_outcome_promoter_accepts_failed_inspection",
					"joint_site_meeting_needed",
					"reviewing_dispute",
					"no_agreement",
					"inspection_withdrawn",
					"upcoming_enum"
				],
				"type": "string"
			},
			"InspectionSummaryResponse": {
				"properties": {
					"inspection_date": {
						"type": "string",
						"format": "date-time"
					},
					"work_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"inspection_reference_number": {
						"type": "string",
						"nullable": true
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionTypeResponse"
					},
					"inspection_type_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
					},
					"inspector_name": {
						"type": "string",
						"nullable": true
					},
					"highway_authority": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"made_safe_by_ha": {
						"type": "boolean",
						"nullable": true
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"inspection_status": {
						"$ref": "#/components/schemas/InspectionStatusResponse"
					},
					"inspection_status_string": {
						"type": "string"
					},
					"date_modified": {
						"type": "string",
						"format": "date-time"
					},
					"promoter_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true
					},
					"promoter_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"ha_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true
					},
					"ha_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"auto_acceptance_due_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"is_auto_accepted": {
						"type": "boolean",
						"nullable": true
					}
				},
				"required": [
					"inspection_date",
					"work_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"inspection_type",
					"inspection_type_string",
					"highway_authority",
					"promoter_organisation",
					"date_created",
					"inspection_status",
					"inspection_status_string",
					"date_modified"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/InspectionSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"InspectionType": {
				"enum": [
					"live_site",
					"reinstatement",
					"non_compliance_follow_up",
					"section_81",
					"investigatory_works"
				],
				"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"
			},
			"InspectionSortColumn": {
				"enum": [
					"inspection_date"
				],
				"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"
				],
				"type": "string"
			},
			"PromoterInspectionOutcomeStatusType": {
				"enum": [
					"inspection_outcome_accepted",
					"inspection_outcome_disputed",
					"joint_site_meeting_needed",
					"inspection_outcome_promoter_disagrees_with_ha_acceptance_on_behalf",
					"no_response"
				],
				"type": "string"
			},
			"HAInspectionOutcomeStatusType": {
				"enum": [
					"inspection_outcome_promoter_accepts_failed_inspection",
					"reviewing_dispute",
					"no_agreement",
					"inspection_withdrawn",
					"no_response"
				],
				"type": "string"
			},
			"WorkstreamStatusResponse": {
				"enum": [
					"active",
					"deactivated",
					"upcoming_enum"
				],
				"type": "string"
			},
			"WorkstreamSummaryResponse": {
				"properties": {
					"prefix": {
						"type": "string"
					},
					"name": {
						"type": "string"
					},
					"description": {
						"type": "string",
						"nullable": true
					},
					"status": {
						"$ref": "#/components/schemas/WorkstreamStatusResponse"
					},
					"status_string": {
						"type": "string"
					},
					"swa_code": {
						"type": "string"
					}
				},
				"required": [
					"prefix",
					"name",
					"status",
					"status_string",
					"swa_code"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkstreamReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/WorkstreamSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkstreamStatus": {
				"enum": [
					"active",
					"deactivated"
				],
				"type": "string"
			},
			"ReinstatementTypeResponse": {
				"enum": [
					"excavation",
					"bar_holes",
					"core_holes",
					"pole_testing",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ReinstatementStatusResponse": {
				"enum": [
					"interim",
					"permanent",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ReinstatementSummaryResponse": {
				"properties": {
					"site_reference_number": {
						"type": "string"
					},
					"work_reference_number": {
						"type": "string"
					},
					"reinstatement_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"street_name": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area_name": {
						"type": "string",
						"nullable": true
					},
					"location_description": {
						"type": "string"
					},
					"registration_date": {
						"type": "string",
						"format": "date-time"
					},
					"reinstatement_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"reinstatement_type": {
						"$ref": "#/components/schemas/ReinstatementTypeResponse"
					},
					"reinstatement_type_string": {
						"type": "string"
					},
					"reinstatement_status": {
						"$ref": "#/components/schemas/ReinstatementStatusResponse"
					},
					"reinstatement_status_string": {
						"type": "string"
					},
					"end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"is_active_reinstatement": {
						"type": "boolean"
					},
					"is_subsumed": {
						"type": "boolean"
					}
				},
				"required": [
					"site_reference_number",
					"work_reference_number",
					"reinstatement_reference_number",
					"promoter_organisation",
					"highway_authority",
					"street_name",
					"location_description",
					"registration_date",
					"reinstatement_type",
					"reinstatement_type_string",
					"reinstatement_status",
					"reinstatement_status_string",
					"is_active_reinstatement",
					"is_subsumed"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ReinstatementSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinstatementSortColumn": {
				"enum": [
					"end_date"
				],
				"type": "string"
			},
			"ReinstatementStatus": {
				"enum": [
					"interim",
					"permanent"
				],
				"type": "string"
			},
			"ForwardPlanStatusResponse": {
				"enum": [
					"raised",
					"cancelled",
					"progressed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"ForwardPlanSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"forward_plan_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"forward_plan_status": {
						"$ref": "#/components/schemas/ForwardPlanStatusResponse"
					},
					"forward_plan_status_string": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"work_reference_number",
					"forward_plan_reference_number",
					"promoter_organisation",
					"highway_authority",
					"location_description",
					"street",
					"town",
					"area",
					"proposed_start_date",
					"proposed_end_date",
					"forward_plan_status",
					"forward_plan_status_string",
					"date_created"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ForwardPlanSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ForwardPlanStatus": {
				"enum": [
					"raised",
					"cancelled",
					"progressed"
				],
				"type": "string"
			},
			"ForwardPlanSortColumn": {
				"enum": [
					"start_date",
					"end_date"
				],
				"type": "string"
			},
			"Section58StatusResponse": {
				"enum": [
					"proposed",
					"in_force",
					"cancelled",
					"closed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section58DurationResponse": {
				"enum": [
					"six_months",
					"one_year",
					"two_years",
					"three_years",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section58SummaryResponse": {
				"properties": {
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"section_58_reference_number": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area": {
						"type": "string",
						"nullable": true
					},
					"section_58_status": {
						"$ref": "#/components/schemas/Section58StatusResponse"
					},
					"section_58_status_string": {
						"type": "string"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"restriction_duration": {
						"$ref": "#/components/schemas/Section58DurationResponse"
					},
					"restriction_duration_string": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"ha_organisation_name": {
						"type": "string"
					}
				},
				"required": [
					"date_created",
					"section_58_reference_number",
					"street",
					"section_58_status",
					"section_58_status_string",
					"start_date",
					"end_date",
					"restriction_duration",
					"restriction_duration_string",
					"usrn",
					"ha_organisation_name"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58ReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/Section58SummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section58Status": {
				"enum": [
					"proposed",
					"in_force",
					"cancelled",
					"closed"
				],
				"type": "string"
			},
			"Section58SortColumn": {
				"enum": [
					"date_created"
				],
				"type": "string"
			},
			"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"
			},
			"Section74PromoterStatusResponse": {
				"enum": [
					"acknowledge_overrun_warning",
					"site_visited_and_rectified",
					"warning_disputed",
					"acknowledge_draft_invoice",
					"charge_under_review",
					"charge_agreed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section74SummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"section_74_reference_number": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"promoter_organisation_name": {
						"type": "string"
					},
					"ha_organisation_name": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"overrun_warning_reasons": {
						"items": {
							"$ref": "#/components/schemas/OverrunWarningReasonResponse"
						},
						"type": "array"
					},
					"overrun_warning_reasons_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					},
					"ha_status": {
						"$ref": "#/components/schemas/Section74HAStatusResponse"
					},
					"ha_status_string": {
						"type": "string"
					},
					"promoter_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/Section74PromoterStatusResponse"
							}
						],
						"nullable": true
					},
					"promoter_status_string": {
						"type": "string",
						"nullable": true
					},
					"latest_ha_response_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"section_74_reference_number",
					"date_created",
					"promoter_organisation_name",
					"ha_organisation_name",
					"location_description",
					"overrun_warning_reasons",
					"overrun_warning_reasons_string",
					"ha_status",
					"ha_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74ReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/Section74SummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section74HAStatus": {
				"enum": [
					"warning_issued",
					"charges_ended",
					"warning_disputed",
					"withdrawn",
					"draft_invoice_issued",
					"resolved"
				],
				"type": "string"
			},
			"Section74SortColumn": {
				"enum": [
					"date_created"
				],
				"type": "string"
			},
			"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",
					"other",
					"unattributed_works_live_site",
					"unattributed_works_completed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"Section81SummaryResponse": {
				"properties": {
					"issue_date": {
						"type": "string",
						"format": "date-time"
					},
					"work_reference_number": {
						"type": "string"
					},
					"section_81_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area": {
						"type": "string",
						"nullable": true
					},
					"section_81_severity": {
						"$ref": "#/components/schemas/Section81SeverityResponse"
					},
					"section_81_severity_string": {
						"type": "string"
					},
					"made_safe_by_ha": {
						"type": "boolean"
					},
					"section_81_status": {
						"$ref": "#/components/schemas/Section81StatusResponse"
					},
					"section_81_status_string": {
						"type": "string"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"section_81_type": {
						"$ref": "#/components/schemas/Section81TypeResponse"
					},
					"section_81_type_string": {
						"type": "string"
					}
				},
				"required": [
					"issue_date",
					"work_reference_number",
					"section_81_reference_number",
					"promoter_organisation",
					"highway_authority",
					"location_description",
					"street",
					"section_81_status",
					"section_81_status_string",
					"status_changed_date",
					"section_81_type",
					"section_81_type_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81ReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/Section81SummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"Section81Status": {
				"enum": [
					"issued",
					"acknowledged",
					"accepted",
					"accepted_fixed",
					"rejected",
					"resolved_by_ha",
					"cancelled",
					"reassigned"
				],
				"type": "string"
			},
			"Section81Severity": {
				"enum": [
					"high",
					"low"
				],
				"type": "string"
			},
			"Section81SortColumn": {
				"enum": [
					"status_changed_date"
				],
				"type": "string"
			},
			"Section81Type": {
				"enum": [
					"tee_valve_access_covers",
					"cabinet",
					"marker_post",
					"pole_post",
					"other",
					"overhead_cables_broken_low_encroaching_onto_highway",
					"unattributed_works_live_site",
					"unattributed_works_completed"
				],
				"type": "string"
			},
			"RoleResponse": {
				"enum": [
					"Planner",
					"HighwayAuthority",
					"Admin",
					"Contractor",
					"API",
					"UI",
					"DataExport",
					"StreetWorksAdmin",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PermissionResponse": {
				"enum": [
					"Permit",
					"Compliance",
					"Work",
					"upcoming_enum"
				],
				"type": "string"
			},
			"RolePermissionsResponse": {
				"properties": {
					"role": {
						"$ref": "#/components/schemas/RoleResponse"
					},
					"role_string": {
						"type": "string"
					},
					"permissions": {
						"items": {
							"$ref": "#/components/schemas/PermissionResponse"
						},
						"type": "array"
					},
					"permissions_string": {
						"items": {
							"type": "string"
						},
						"type": "array"
					}
				},
				"required": [
					"role",
					"role_string",
					"permissions",
					"permissions_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkstreamAccessLevelResponse": {
				"enum": [
					"read_only",
					"full_write",
					"upcoming_enum"
				],
				"type": "string"
			},
			"UserWorkstreamAccess": {
				"properties": {
					"workstream_prefix": {
						"type": "string"
					},
					"access_level": {
						"$ref": "#/components/schemas/WorkstreamAccessLevelResponse"
					},
					"access_level_string": {
						"type": "string"
					}
				},
				"required": [
					"workstream_prefix",
					"access_level",
					"access_level_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"UsersSummaryResponse": {
				"properties": {
					"first_name": {
						"type": "string",
						"nullable": true
					},
					"last_name": {
						"type": "string",
						"nullable": true
					},
					"email": {
						"type": "string"
					},
					"role_permissions": {
						"items": {
							"$ref": "#/components/schemas/RolePermissionsResponse"
						},
						"type": "array",
						"nullable": true
					},
					"workstreams": {
						"items": {
							"$ref": "#/components/schemas/UserWorkstreamAccess"
						},
						"type": "array",
						"nullable": true
					}
				},
				"required": [
					"email"
				],
				"type": "object",
				"additionalProperties": false
			},
			"UsersReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/UsersSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CSVExportStatusResponse": {
				"enum": [
					"queued",
					"in_progress",
					"ready",
					"failed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CSVExportTypeResponse": {
				"enum": [
					"FEE",
					"FORWARD_PLAN",
					"FPN",
					"INSPECTION",
					"PERMIT",
					"REINSTATEMENT",
					"SECTION_81",
					"PERMIT_ALTERATION",
					"ORGANISATION_DATA",
					"COMMENT",
					"REPORTING_INSPECTION_OUTCOMES",
					"REPORTING_PERMITS_CREATED",
					"REPORTING_PERMIT_OUTCOMES",
					"REPORTING_ALTERATIONS_CREATED",
					"REPORTING_ALTERATION_OUTCOMES",
					"REPORTING_FPNS_CREATED",
					"REPORTING_PERMITS_DEEMED",
					"SECTION_58",
					"SECTION_74",
					"SAMPLE_INSPECTIONS_DUE",
					"EXPIRING_INTERIM_REINSTATEMENT",
					"PBI_SAMPLE_INSPECTIONS_DUE",
					"REPORTING_PBI_PASS_FAIL_RATES",
					"NUMBER_OF_INSPECTION_UNITS",
					"PRIVATE_STREET_NOTICE",
					"REINSPECTION",
					"NON_COMPLIANCE",
					"REINSTATEMENTS_DUE",
					"MATERIAL_CLASSIFICATION",
					"PBI_SAMPLE_INSPECTION_TARGET",
					"INTERESTED_PARTY_PERMIT",
					"CHANGE_REQUEST",
					"upcoming_enum"
				],
				"type": "string"
			},
			"CSVExportSummaryResponse": {
				"properties": {
					"csv_export_id": {
						"type": "number",
						"format": "double"
					},
					"filename": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"csv_export_status": {
						"$ref": "#/components/schemas/CSVExportStatusResponse"
					},
					"csv_export_status_string": {
						"type": "string"
					},
					"username": {
						"type": "string"
					},
					"csv_export_type": {
						"$ref": "#/components/schemas/CSVExportTypeResponse"
					},
					"csv_export_type_string": {
						"type": "string"
					},
					"export_description": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"csv_export_id",
					"filename",
					"date_created",
					"csv_export_status",
					"csv_export_status_string",
					"username",
					"csv_export_type",
					"csv_export_type_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"CSVExportReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/CSVExportSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"GeographicalAreaResponse": {
				"properties": {
					"geographical_area_reference_number": {
						"type": "string",
						"description": "The value to supply to the geographical_area_reference_number filter on the reporting endpoints"
					},
					"area_name": {
						"type": "string",
						"description": "The name given to the area by the owning highway authority"
					},
					"file_id": {
						"type": "number",
						"format": "double",
						"description": "The identifier of the file the area was uploaded from"
					},
					"number_of_usrns": {
						"type": "number",
						"format": "double",
						"description": "How many USRNs the area covers\nThe areas named in a single reporting request must not cover more than 60000 USRNs in total by default"
					},
					"date_modified": {
						"type": "string",
						"format": "date-time",
						"description": "When the area was last changed"
					}
				},
				"required": [
					"geographical_area_reference_number",
					"area_name",
					"file_id",
					"number_of_usrns",
					"date_modified"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionTargetSummaryResponse": {
				"properties": {
					"pbi_sample_inspection_target_reference_number": {
						"type": "string"
					},
					"organisation_name": {
						"type": "string"
					},
					"org_ref": {
						"type": "string"
					},
					"inspection_units": {
						"type": "number",
						"format": "double"
					},
					"inspection_rate": {
						"type": "number",
						"format": "double"
					},
					"target_a": {
						"type": "number",
						"format": "double"
					},
					"target_b": {
						"type": "number",
						"format": "double"
					},
					"target_c": {
						"type": "number",
						"format": "double"
					},
					"completed_a": {
						"type": "number",
						"format": "double"
					},
					"completed_b": {
						"type": "number",
						"format": "double"
					},
					"completed_c": {
						"type": "number",
						"format": "double"
					},
					"generated_b": {
						"type": "number",
						"format": "double"
					},
					"generated_c": {
						"type": "number",
						"format": "double"
					},
					"start_date": {
						"type": "string",
						"format": "date-time"
					},
					"end_date": {
						"type": "string",
						"format": "date-time"
					},
					"is_inspection_rate_auto_updated": {
						"type": "boolean"
					}
				},
				"required": [
					"pbi_sample_inspection_target_reference_number",
					"organisation_name",
					"org_ref",
					"inspection_units",
					"inspection_rate",
					"target_a",
					"target_b",
					"target_c",
					"completed_a",
					"completed_b",
					"completed_c",
					"generated_b",
					"generated_c",
					"is_inspection_rate_auto_updated"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionTargetReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PbiSampleInspectionTargetSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionTargetSortColumn": {
				"enum": [
					"is_inspection_rate_auto_updated"
				],
				"type": "string"
			},
			"PbiSampleInspectionSummaryResponse": {
				"properties": {
					"pbi_sample_inspection_reference_number": {
						"type": "string"
					},
					"work_reference_number": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string",
						"nullable": true
					},
					"area": {
						"type": "string",
						"nullable": true
					},
					"location_description": {
						"type": "string"
					},
					"promoter_organisation": {
						"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",
					"work_reference_number",
					"street",
					"location_description",
					"promoter_organisation",
					"inspection_category",
					"inspection_category_string",
					"sample_expiry_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PbiSampleInspectionSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleInspectionSortColumn": {
				"enum": [
					"work_end_date",
					"sample_expiry_date"
				],
				"type": "string"
			},
			"WorkSearchResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					},
					"work_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"work_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"work_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"work_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					}
				},
				"required": [
					"work_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"work_status",
					"work_status_string",
					"work_start_date",
					"work_end_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"WorkSearchReportingResponse": {
				"properties": {
					"rows": {
						"items": {
							"$ref": "#/components/schemas/WorkSearchResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinspectionSummaryResponse": {
				"properties": {
					"inspection_date": {
						"type": "string",
						"format": "date-time"
					},
					"work_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"inspection_type": {
						"$ref": "#/components/schemas/InspectionTypeResponse"
					},
					"inspection_type_string": {
						"type": "string"
					},
					"inspection_category": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionCategoryResponse"
							}
						],
						"nullable": true
					},
					"inspection_category_string": {
						"type": "string",
						"nullable": true
					},
					"highway_authority": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"date_modified": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"inspection_date",
					"work_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"inspection_type",
					"inspection_type_string",
					"highway_authority",
					"promoter_organisation",
					"date_modified"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinspectionReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ReinspectionSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ReinspectionSortColumn": {
				"enum": [
					"reinspection_date"
				],
				"type": "string"
			},
			"PrivateStreetStatusResponse": {
				"enum": [
					"cancelled",
					"issued",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PrivateStreetSummaryResponse": {
				"properties": {
					"private_street_reference_number": {
						"type": "string"
					},
					"works_location_description": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"ha_organisation": {
						"type": "string"
					},
					"work_reference_number": {
						"type": "string"
					},
					"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
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"status": {
						"$ref": "#/components/schemas/PrivateStreetStatusResponse"
					},
					"status_string": {
						"type": "string"
					}
				},
				"required": [
					"private_street_reference_number",
					"works_location_description",
					"promoter_organisation",
					"ha_organisation",
					"work_reference_number",
					"start_date",
					"end_date",
					"date_created",
					"status",
					"status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PrivateStreetSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PrivateStreetNoticeSortColumn": {
				"enum": [
					"date_created",
					"start_date",
					"end_date"
				],
				"type": "string"
			},
			"PrivateStreetStatus": {
				"enum": [
					"cancelled",
					"issued"
				],
				"type": "string"
			},
			"NonComplianceStatusResponse": {
				"enum": [
					"issued",
					"withdrawn",
					"resolved",
					"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"
			},
			"NonComplianceSummaryResponse": {
				"properties": {
					"non_compliance_reference_number": {
						"type": "string"
					},
					"work_reference_number": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"ha_organisation": {
						"type": "string"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"associated_inspections": {
						"type": "number",
						"format": "double"
					},
					"non_compliance_status": {
						"$ref": "#/components/schemas/NonComplianceStatusResponse"
					},
					"non_compliance_status_string": {
						"type": "string"
					},
					"latest_ha_response_status": {
						"$ref": "#/components/schemas/NonComplianceResponseStatusResponse"
					},
					"latest_ha_response_status_string": {
						"type": "string"
					},
					"latest_ha_response_date": {
						"type": "string",
						"format": "date-time"
					},
					"latest_promoter_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/NonComplianceResponseStatusResponse"
							}
						],
						"nullable": true
					},
					"latest_promoter_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"latest_promoter_response_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"most_recent_inspection_type": {
						"$ref": "#/components/schemas/InspectionTypeResponse"
					},
					"most_recent_inspection_type_string": {
						"type": "string"
					},
					"most_recent_inspection_outcome": {
						"$ref": "#/components/schemas/InspectionOutcomeResponse"
					},
					"most_recent_inspection_outcome_string": {
						"type": "string"
					},
					"most_recent_inspection_promoter_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true
					},
					"most_recent_inspection_promoter_response_status_string": {
						"type": "string",
						"nullable": true
					},
					"most_recent_inspection_ha_response_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/InspectionOutcomeStatusTypeResponse"
							}
						],
						"nullable": true
					},
					"most_recent_inspection_ha_response_status_string": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"non_compliance_reference_number",
					"work_reference_number",
					"promoter_organisation",
					"ha_organisation",
					"date_created",
					"associated_inspections",
					"non_compliance_status",
					"non_compliance_status_string",
					"latest_ha_response_status",
					"latest_ha_response_status_string",
					"latest_ha_response_date",
					"street",
					"town",
					"area",
					"most_recent_inspection_type",
					"most_recent_inspection_type_string",
					"most_recent_inspection_outcome",
					"most_recent_inspection_outcome_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonComplianceReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/NonComplianceSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"NonComplianceStatus": {
				"enum": [
					"issued",
					"withdrawn",
					"resolved"
				],
				"type": "string"
			},
			"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",
					"no_response"
				],
				"type": "string"
			},
			"NonComplianceSortColumn": {
				"enum": [
					"date_created"
				],
				"type": "string"
			},
			"MaterialClassificationClassification": {
				"enum": [
					"hazardous",
					"non_hazardous"
				],
				"type": "string"
			},
			"HazardousMaterialType": {
				"enum": [
					"coal_tar",
					"total_petroleum_hydrocarbons",
					"ph",
					"heavy_metal",
					"asbestos",
					"other"
				],
				"type": "string"
			},
			"MaterialClassificationSummaryResponse": {
				"properties": {
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"sample_date": {
						"type": "string",
						"format": "date-time"
					},
					"material_classification_reference_number": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"material_classification_classification": {
						"$ref": "#/components/schemas/MaterialClassificationClassification"
					},
					"hazardous_material_types": {
						"items": {
							"$ref": "#/components/schemas/HazardousMaterialType"
						},
						"type": "array",
						"nullable": true
					},
					"hazardous_material_type_other_description": {
						"type": "string",
						"nullable": true
					}
				},
				"required": [
					"date_created",
					"sample_date",
					"material_classification_reference_number",
					"street",
					"town",
					"area",
					"usrn",
					"material_classification_classification"
				],
				"type": "object",
				"additionalProperties": false
			},
			"MaterialClassificationReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/MaterialClassificationSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"AsyncJobStatusResponse": {
				"enum": [
					"queued",
					"in_progress",
					"complete",
					"failed",
					"upcoming_enum"
				],
				"type": "string"
			},
			"PbiSampleGenerationJobsSummaryResponse": {
				"properties": {
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"async_job_status": {
						"$ref": "#/components/schemas/AsyncJobStatusResponse"
					},
					"async_job_status_string": {
						"type": "string"
					},
					"username": {
						"type": "string"
					}
				},
				"required": [
					"date_created",
					"async_job_status",
					"async_job_status_string",
					"username"
				],
				"type": "object",
				"additionalProperties": false
			},
			"PbiSampleGenerationJobsReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/PbiSampleGenerationJobsSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"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": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"change_request_reference_number": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"promoter": {
						"type": "string"
					},
					"work_category": {
						"$ref": "#/components/schemas/WorkCategoryResponse"
					},
					"work_category_string": {
						"type": "string"
					},
					"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"
					},
					"date_created": {
						"type": "string",
						"format": "date-time"
					},
					"deadline_date": {
						"type": "string",
						"format": "date-time"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"change_request_reference_number",
					"street",
					"town",
					"area",
					"location_description",
					"highway_authority",
					"promoter",
					"work_category",
					"work_category_string",
					"change_request_status",
					"change_request_status_string",
					"change_request_type",
					"change_request_type_string",
					"date_created",
					"deadline_date",
					"status_changed_date"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestStatus": {
				"enum": [
					"submitted",
					"granted",
					"refused",
					"deemed",
					"cancelled",
					"granted_with_duration_challenge",
					"revoked",
					"auto_applied"
				],
				"type": "string"
			},
			"ChangeRequestType": {
				"enum": [
					"PROMOTER_IMPOSED_CHANGE",
					"PROMOTER_CHANGE_REQUEST",
					"HA_CHANGE_REQUEST",
					"HA_IMPOSED_CHANGE",
					"WORK_EXTENSION",
					"DURATION_CHALLENGE",
					"MODIFIED_PERMIT"
				],
				"type": "string"
			},
			"ChangeRequestSortColumn": {
				"enum": [
					"date_created",
					"deadline_date"
				],
				"type": "string"
			},
			"ChangeRequestDurationChallengeSummaryResponse": {
				"properties": {
					"work_reference_number": {
						"type": "string"
					},
					"permit_reference_number": {
						"type": "string"
					},
					"change_request_reference_number": {
						"type": "string"
					},
					"location_description": {
						"type": "string"
					},
					"street": {
						"type": "string"
					},
					"town": {
						"type": "string"
					},
					"area": {
						"type": "string"
					},
					"usrn": {
						"type": "number",
						"format": "double"
					},
					"promoter_swa_code": {
						"type": "string"
					},
					"promoter_organisation": {
						"type": "string"
					},
					"highway_authority": {
						"type": "string"
					},
					"proposed_start_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"proposed_start_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"proposed_end_time": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_start_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"actual_end_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"reasonable_period_end_date": {
						"type": "string",
						"format": "date-time"
					},
					"status_changed_date": {
						"type": "string",
						"format": "date-time"
					},
					"duration_challenge_review_status": {
						"allOf": [
							{
								"$ref": "#/components/schemas/DurationChallengeReviewStatusResponse"
							}
						],
						"nullable": true
					},
					"duration_challenge_review_status_string": {
						"type": "string"
					},
					"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"
					},
					"duration_challenge_non_acceptance_response_update_date": {
						"type": "string",
						"format": "date-time",
						"nullable": true
					},
					"duration_challenge_follow_up_review_complete": {
						"type": "boolean",
						"nullable": true
					},
					"work_status": {
						"$ref": "#/components/schemas/WorkStatusResponse"
					},
					"work_status_string": {
						"type": "string"
					}
				},
				"required": [
					"work_reference_number",
					"permit_reference_number",
					"change_request_reference_number",
					"location_description",
					"street",
					"town",
					"area",
					"usrn",
					"promoter_swa_code",
					"promoter_organisation",
					"highway_authority",
					"proposed_start_date",
					"proposed_end_date",
					"reasonable_period_end_date",
					"status_changed_date",
					"work_status",
					"work_status_string"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestDurationChallengeReportingResponse": {
				"properties": {
					"pagination": {
						"$ref": "#/components/schemas/PaginationResponse"
					},
					"rows": {
						"items": {
							"$ref": "#/components/schemas/ChangeRequestDurationChallengeSummaryResponse"
						},
						"type": "array"
					}
				},
				"required": [
					"pagination",
					"rows"
				],
				"type": "object",
				"additionalProperties": false
			},
			"ChangeRequestDurationChallengeSortColumn": {
				"enum": [
					"status_changed_date"
				],
				"type": "string"
			}
		},
		"securitySchemes": {
			"token": {
				"type": "apiKey",
				"name": "token",
				"in": "header"
			}
		}
	},
	"info": {
		"title": "Street Manager Reporting API Stable",
		"version": "1.0.0",
		"description": "See API specification Resource Guide > Reporting API for more information on paging and endpoints\nNOTE: Swagger Editor/UI does not display all description text for enumerations and child elements, check swagger.json for full description text",
		"license": {
			"name": "MIT"
		},
		"contact": {}
	},
	"paths": {
		"/activities": {
			"get": {
				"operationId": "GetActivities",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ActivityReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of activities such as skips, scaffolding, events and Section 58s.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nFor Highway Authority users results are limited to activities raised by their own organisation, plus any\nadditional organisations they have access to unless include_additional_orgs is set to false; for Planner and\nContractor users results are not limited by organisation. Every geographical area reference supplied must\nexist and be accessible to the caller's organisation, otherwise the request is rejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum number\nof USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Activities for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the name of the highway authority that raised the activity. Partial, case-insensitive matching. Max length 100 characters. Only applied for Planner and Contractor users; accepted but ignored for Highway Authority users",
						"in": "query",
						"name": "ha_organisation_name",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter to one or more types of activity. Values must be unique",
						"in": "query",
						"name": "activity_activity_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ActivityActivityType"
							}
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Free-text search across the activity reference number, street information and USRN. Partial matching is supported and special characters are escaped before searching",
						"in": "query",
						"name": "query",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Column to order results by. The creation date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ActivitySortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Restricts results to activities whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether activities from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/alterations": {
			"get": {
				"operationId": "GetAlterations",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/AlterationReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of permit alterations.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nContractor users must supply swa_code identifying the promoter they are acting for, and that promoter\norganisation must exist, must not be suspended or disabled, and must have a contract with the contractor's\nown organisation, otherwise access is refused. Planner users only see alterations on works in the\nworkstreams they are assigned to within their own organisation; Contractor users only see alterations on\nworks promoted by the organisation identified by swa_code and within the workstreams they are assigned to\nfor that organisation; Highway Authority users only see alterations on works where their own organisation\nis the highway authority, plus any additional organisations they have access to unless include_additional_orgs\nis set to false. Every geographical area reference supplied must exist and be accessible to the caller's\norganisation, otherwise the request is rejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum number\nof USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Alterations for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter to one or more alteration statuses. Values must be unique",
						"in": "query",
						"name": "alteration_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/AlterationStatus"
							}
						}
					},
					{
						"description": "Filter to one or more alteration types. Values must be unique",
						"in": "query",
						"name": "alteration_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/AlterationType"
							}
						}
					},
					{
						"description": "Filter by the status of the work the alteration belongs to. Values must be unique",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by the category of the permit the alteration belongs to. Values must be unique",
						"in": "query",
						"name": "work_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkCategory"
							}
						}
					},
					{
						"description": "Filter by the lane rental assessment outcome recorded on the permit. Values must be unique",
						"in": "query",
						"name": "lane_rental_assessment_outcome",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/LaneRentalAssessmentOutcome"
							}
						}
					},
					{
						"description": "Only return alterations created on or after this date and time",
						"in": "query",
						"name": "start_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Only return alterations created on or before this date and time. Must be on or after startDateCreated",
						"in": "query",
						"name": "end_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. Defaults to the creation date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/AlterationSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Set to true to return only alterations on permits marked as traffic sensitive. Setting it to false has no effect",
						"in": "query",
						"name": "is_traffic_sensitive",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations on permits using high impact traffic management. Setting it to false has no effect",
						"in": "query",
						"name": "is_high_impact_traffic_management",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations that are work extensions. Setting it to false has no effect",
						"in": "query",
						"name": "is_duration_extension",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations on permits that were given early start pre-approval. Setting it to false has no effect",
						"in": "query",
						"name": "is_early_start",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations that were deemed. Setting it to false has no effect",
						"in": "query",
						"name": "is_deemed",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations where lane rental charges have not been agreed. Setting it to false has no effect",
						"in": "query",
						"name": "lane_rental_charges_not_agreed",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only alterations where lane rental charges potentially apply. Setting it to false has no effect",
						"in": "query",
						"name": "lane_rental_charges_potentially_apply",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to streets that fall within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Only return alterations whose status last changed on or after this date and time",
						"in": "query",
						"name": "status_update_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Only return alterations whose status last changed on or before this date and time. Must be on or after statusUpdateDateFrom",
						"in": "query",
						"name": "status_update_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation; for Planner and Contractor users it searches the highway authority organisation",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the alteration's reference number. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "permit_alteration_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether records from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/alterations/duration-challenges": {
			"get": {
				"operationId": "GetAlterationDurationChallenges",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/AlterationDurationChallengeReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of permit alterations that have been granted with a duration challenge,\ntogether with the review and non-acceptance response recorded against each one.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nContractor users must supply swa_code identifying the promoter they are acting for, and that promoter\norganisation must exist, must not be suspended or disabled, and must have a contract with the contractor's\nown organisation, otherwise access is refused. Planner users only see alterations on works in the\nworkstreams they are assigned to within their own organisation; Contractor users only see alterations on\nworks promoted by the organisation identified by swa_code and within the workstreams they are assigned to\nfor that organisation; Highway Authority users only see alterations on works where their own organisation\nis the highway authority, plus any additional organisations they have access to unless include_additional_orgs\nis set to false. Every geographical area reference supplied must exist and be accessible to the caller's\norganisation, otherwise the request is rejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum number\nof USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Permit Alteration Duration Challenges for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The status changed date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/AlterationDurationChallengeSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation; for Planner and Contractor users it searches the highway authority organisation",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to streets that fall within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by the promoter's response to the duration challenge. Values must be unique",
						"in": "query",
						"name": "duration_challenge_review_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeReviewStatus"
							}
						}
					},
					{
						"description": "Filter by the authority's response where the promoter did not accept the challenge. Values must be unique",
						"in": "query",
						"name": "duration_challenge_non_acceptance_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatus"
							}
						}
					},
					{
						"description": "Filter by the status of the work the alteration belongs to. Values must be unique",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the alteration's reference number. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "permit_alteration_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether records from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/permits": {
			"get": {
				"operationId": "GetPermits",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Permits for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of permits, which is the primary reporting view of permit activity in Street Manager.\n\nResults are scoped to the caller. Planner users see permits on works belonging to workstreams they are a\nmember of. Highway Authority users see permits on works where they are the authority, plus works belonging\nto any additional organisations they have access to unless include_additional_orgs is set to false.\nContractor users must supply swa_code and are scoped to the promoter organisation it identifies; the code\nmust belong to an organisation the user may contract for and that organisation must not be suspended or\ndisabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. The work_category, is_traffic_sensitive,\nis_high_impact_traffic_management, is_early_start, has_excavation and reasonable_period_end_date filters,\nand sorting by deadline_date or reasonable_period_end_date, are applied against the permit's current\nversion. All other filters are applied to the permit or work record directly.\n\nNote that the work_reference_number filter is matched against the permit reference column rather than the\nwork reference, so it behaves as a second permit reference filter.\n\nThe true/false filters are only applied when set to true. Setting one to false has the same effect as\nomitting it rather than inverting the filter.\n\nThe hs2_works_only, consultation_works_only, consent_works_only and unacknowledged_by_ha_only filters all\nrestrict results to works promoted by HS2, identified by its organisation reference.\n\nThe start_date and end_date pair selects permits whose permitted period overlaps the range. The work_* date\npairs are applied to the permit start and end dates rather than to the work record's own dates.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by sort_column and sort_direction, defaulting to the permit\ncreation date descending. When include_total_count is left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by permit status",
						"in": "query",
						"name": "status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/PermitStatus"
							}
						}
					},
					{
						"description": "Filter by the status of the work the permit belongs to",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by the category of works, taken from the permit's current version",
						"in": "query",
						"name": "work_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkCategory"
							}
						}
					},
					{
						"description": "Filter by the outcome of the authority's lane rental assessment",
						"in": "query",
						"name": "lane_rental_assessment_outcome",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/LaneRentalAssessmentOutcome"
							}
						}
					},
					{
						"description": "When true, returns only the permit currently in force for each work",
						"in": "query",
						"name": "active_permit_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Returns permits whose permitted period ends on or after this date",
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose permitted period starts on or before this date. Must occur on or after start_date",
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits starting on or after this date",
						"in": "query",
						"name": "work_start_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits starting on or before this date. Must occur on or after work_start_date_from",
						"in": "query",
						"name": "work_start_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits ending on or after this date",
						"in": "query",
						"name": "work_end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits ending on or before this date. Must occur on or after work_end_date_from",
						"in": "query",
						"name": "work_end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits created on or after this date",
						"in": "query",
						"name": "start_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits created on or before this date",
						"in": "query",
						"name": "end_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. Defaults to the permit creation date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PermitSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "When true, returns only permits on traffic sensitive streets",
						"in": "query",
						"name": "is_traffic_sensitive",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits using a high impact traffic management type",
						"in": "query",
						"name": "is_high_impact_traffic_management",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits with no final reinstatement registered",
						"in": "query",
						"name": "has_no_final_registration",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits where excavation was carried out",
						"in": "query",
						"name": "has_excavation",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits with early start pre-approval recorded",
						"in": "query",
						"name": "is_early_start",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits that were deemed rather than assessed",
						"in": "query",
						"name": "is_deemed",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits with lane rental charges that have not been agreed",
						"in": "query",
						"name": "lane_rental_charges_not_agreed",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits that are chargeable, potentially chargeable or flagged as lane rental",
						"in": "query",
						"name": "lane_rental_charges_potentially_apply",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "When true, returns only permits that have had a modification requested at any point",
						"in": "query",
						"name": "ever_modification_requested",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only permits on works promoted by HS2",
						"in": "query",
						"name": "hs2_works_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only HS2 consultation permits",
						"in": "query",
						"name": "consultation_works_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only HS2 consent permits",
						"in": "query",
						"name": "consent_works_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "When true, returns only HS2 consultation permits the authority has not acknowledged",
						"in": "query",
						"name": "unacknowledged_by_ha_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "When true, returns only permits whose duration has been challenged",
						"in": "query",
						"name": "is_duration_challenged",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by permit reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "permit_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Matched against the permit reference rather than the work reference. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Returns permits whose reasonable period ends on or after this date",
						"in": "query",
						"name": "reasonable_period_end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose reasonable period ends on or before this date. Must occur on or after reasonable_period_end_date_from",
						"in": "query",
						"name": "reasonable_period_end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/permits/duration-challenges": {
			"get": {
				"operationId": "GetPermitDurationChallenges",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitDurationChallengeReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Permit Duration Challenges for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of permits whose duration has been challenged by the highway authority, together with\nthe promoter's review of the challenge and the authority's follow-up where the challenge was not accepted.\n\nThe report is always restricted to permits flagged as duration challenged; there is no way to retrieve\nunchallenged permits through this endpoint.\n\nScoping is the same as the main permits report: Planner users are limited to their workstreams, Highway\nAuthority users to works they are the authority for plus any additional organisations they have access to,\nand Contractor users to the promoter identified by swa_code.\n\nBoth status filters accept no_response, which returns records where that response has not yet been given\nrather than records holding a literal no_response value. It can be combined with other values.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by sort_column and sort_direction, defaulting to the date the\nassessment status last changed, descending. When include_total_count is left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. Defaults to the date the assessment status last changed",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PermitDurationChallengeSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by the promoter's review of the challenge. Supplying no_response returns records with no review recorded",
						"in": "query",
						"name": "duration_challenge_review_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeReviewStatus"
							}
						}
					},
					{
						"description": "Filter by the authority's response where the promoter did not accept the challenge. Supplying no_response returns records with no response recorded",
						"in": "query",
						"name": "duration_challenge_non_acceptance_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatus"
							}
						}
					},
					{
						"description": "Filter by the status of the work the permit belongs to",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by permit reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "permit_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/permits/reinstatements-due": {
			"get": {
				"operationId": "GetReinstatementsDue",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReinstatementsDueReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Reinstatements Due for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of permits that involved excavation but have no reinstatement registered against them,\nso that promoters can see what they still owe and authorities can see what is outstanding against them.\n\nA permit appears in this report only when excavation was carried out and no reinstatement record exists for\nit. Neither condition can be switched off.\n\nYou must supply registration_due_date_from, registration_due_date_to, or both, and at least one of the two\nmust be today's date. A from date must additionally fall within the last 90 days and no later than today,\nand a to date must fall no earlier than today and no later than 10 days from now. This keeps the report\nanchored to the present rather than allowing an open-ended historic query.\n\nScoping is the same as the main permits report: Planner users are limited to their workstreams, Highway\nAuthority users to works they are the authority for plus any additional organisations they have access to,\nand Contractor users to the promoter identified by swa_code.\n\nThe organisation name returned on each record is the other party: Planner and Contractor users see the\nhighway authority, and Highway Authority users see the promoter.\n\nUnlike the other reports on this controller, geographical area references supplied here are used for\nfiltering but are not checked for existence or accessibility, and the USRN limit is not applied.\n\nA page contains at most 25 records, always ordered by the date the works stopped, descending. There are no\nsort parameters. When include_total_count is left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by work reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns records where the works stopped on or after this date",
						"in": "query",
						"name": "work_end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns records where the works stopped on or before this date. Must occur on or after work_end_date_from",
						"in": "query",
						"name": "work_end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns records whose reinstatement registration is due on or after this date. Must fall within the last 90 days and no later than today",
						"in": "query",
						"name": "registration_due_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns records whose reinstatement registration is due on or before this date. Must fall no earlier than today and no later than 10 days from now",
						"in": "query",
						"name": "registration_due_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/permits/files": {
			"get": {
				"operationId": "GetPermitFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Permit Files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to the current version of a single permit. Unlike the other reports on this\ncontroller this is not a paged report: every matching file is returned in one response, and there are no\npaging, sorting or total count parameters.\n\npermit_reference_number is mandatory. If no permit holds that reference the request is rejected as not\nfound. Access is then decided from the work the permit belongs to rather than from the permit itself, so a\ncaller who may read the work may list its permit files.\n\nFiles are matched by filename extension. Supplying file_type therefore excludes any file whose extension\nfalls outside the categories requested, and because the categories are combined with AND rather than OR,\nsupplying both returns no files. Omit file_type to retrieve everything attached to the permit.\n\nAny unexpected failure while retrieving the permit, the work or the files is logged and returned as a\nserver error.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the permit whose files are required. Max length 100 characters",
						"in": "query",
						"name": "permit_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/fixed-penalty-notices": {
			"get": {
				"operationId": "GetFPNs",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FPNReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get FPNs for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a page of fixed penalty notices visible to the authenticated user.\nPlanner users see FPNs on works in the workstreams they are assigned to within their own\norganisation. Contractor users must supply swa_code identifying the promoter they are acting for;\nthat organisation must exist, must not be suspended or disabled and must hold a contract with the\ncontractor's organisation, and results are limited to that promoter and to the workstreams the\ncontractor is assigned to for it. Highway Authority users see FPNs issued by their own organisation,\nplus any additional organisations they have access to unless include_additional_orgs is false.\n\nstart_date and end_date bound the issue date of the notice, while status_changed_date_from and\nstatus_changed_date_to bound the date the status last changed. organisation, street_descriptor,\nusrn and work_reference_number are all partial matches; street_descriptor is matched as whole words.\nThe shared query parameter is not accepted by this endpoint and is always passed as null.\n\nsort_column accepts issue_date_time and status_changed_date and defaults to issue_date_time.\nsort_direction defaults to descending. A page contains up to 25 records. include_total_count\ndefaults to true and the total is capped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not accessible\nreturns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in total (60000 by\ndefault) return 412. A failed swa_code check returns 401. If the overall request timeout has already\nelapsed when these checks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the status of the notice. Values must be unique",
						"in": "query",
						"name": "status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FPNStatus"
							}
						}
					},
					{
						"description": "Returns notices issued on or after this date and time",
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices issued on or before this date and time. Must be on or after startDate",
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to notices on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by the offence the notice was issued for. Values must be unique",
						"in": "query",
						"name": "offence_code",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/OffenceCode"
							}
						}
					},
					{
						"description": "Returns notices whose status last changed on or after this date and time",
						"in": "query",
						"name": "status_changed_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices whose status last changed on or before this date and time. Must be on or after statusChangedDateFrom",
						"in": "query",
						"name": "status_changed_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Column to order results by. The issue date and the status changed date are the options. Defaults to the issue date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/FPNSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation name; for Planner and Contractor users it searches the highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the reference of the work the notice relates to. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether notices belonging to additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/fixed-penalty-notices/files": {
			"get": {
				"operationId": "GetFPNFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get FPNs for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the list of files attached to a single fixed penalty notice. fpn_reference_number is\nrequired and is matched exactly. If no FPN exists with that reference the request returns 404.\n\nAccess is checked against the work the FPN belongs to rather than against the FPN itself. Highway\nAuthority users may read the files on any FPN. Planner and Contractor users must be assigned to the\nworkstream of the work the FPN was issued against, and for Contractor users the promoter organisation\nmust not be suspended or disabled. A failed check returns 401.\n\nOnly files that have finished uploading are returned. file_type narrows the list by file extension:\ndocuments covers pdf, doc and docx, and images covers jpg, jpeg, png, gif, tiff and bmp. The two\nvalues are combined with AND rather than OR, so supplying both returns nothing. Files whose extension\nmatches neither category are excluded whenever file_type is supplied.\n\nThis endpoint is not paged and takes no offset; every matching file is returned, ordered by upload\ndate descending. Any unexpected failure, including a database query exceeding the 30 second timeout,\nis logged and returned as 500. If the overall request timeout has already elapsed when validation\ncompletes, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the fixed penalty notice whose files are being requested. Max length 100 characters",
						"in": "query",
						"name": "fpn_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. The values are combined with AND, so supplying both returns no files, and files whose extension matches neither category are excluded whenever this is supplied. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/comments": {
			"get": {
				"operationId": "GetComments",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/CommentReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of the comments exchanged on works, most recently created first.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nContractor users must supply swa_code identifying the promoter they are acting for, and that promoter\norganisation must exist, must not be suspended or disabled, and must have a contract with the contractor's\nown organisation, otherwise access is refused. Planner users only see comments on works in the workstreams\nthey are assigned to within their own organisation; Contractor users only see comments their nominated\npromoter organisation authored or received, further restricted to the workstreams they are assigned to for\nthat organisation; Highway Authority users only see comments their own organisation authored or received,\nplus those of any additional organisations they have access to unless include_additional_orgs is set to\nfalse. Comments another organisation has marked as internal are never returned. Every geographical area\nreference supplied must exist and be accessible to the caller's organisation, otherwise the request is\nrejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum\nnumber of USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Comments for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to comments on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Returns comments created on or after this date and time",
						"in": "query",
						"name": "date_created_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns comments created on or before this date and time. Must be on or after dateCreatedFrom",
						"in": "query",
						"name": "date_created_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by what the comment is about. Values must be unique",
						"in": "query",
						"name": "topic",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/CommentTopic"
							}
						}
					},
					{
						"description": "Set to true to return only comments the caller's own organisation marked as internal. Setting it to false has no effect",
						"in": "query",
						"name": "is_internal",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only comments that have been read. Setting it to false has no effect. Supplying this together with isNotRead returns both, rather than neither",
						"in": "query",
						"name": "is_read",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only comments that have not been read. Setting it to false has no effect. Supplying this together with isRead returns both, rather than neither",
						"in": "query",
						"name": "is_not_read",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Filter by the reference of the work the comment is attached to. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the email address of the person who wrote the comment. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "author_email_address",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Set to true to return only comments authored by an organisation other than the caller's own. Setting it to false has no effect. Supplying this together with isOutgoing returns both, rather than neither",
						"in": "query",
						"name": "is_incoming",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only comments authored by the caller's own organisation. Setting it to false has no effect. Supplying this together with isIncoming returns both, rather than neither",
						"in": "query",
						"name": "is_outgoing",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether comments from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/inspections": {
			"get": {
				"operationId": "GetInspections",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/InspectionReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get inspections for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a page of inspections visible to the authenticated user.\nPlanner users see inspections on works in the workstreams they are assigned to within their own\norganisation. Contractor users must supply swa_code identifying the promoter they are acting for;\nthat organisation must exist, must not be suspended or disabled and must hold a contract with the\ncontractor's organisation, and results are limited to that promoter and to the workstreams the\ncontractor is assigned to for it. Highway Authority users see inspections carried out by their own\norganisation, plus any additional organisations they have access to unless include_additional_orgs\nis false.\n\nstart_date and end_date bound the date the inspection took place, while start_date_created and\nend_date_created bound the date the inspection record was created. organisation, street_descriptor,\nusrn and work_reference_number are all partial matches; street_descriptor is matched as whole words.\nThe shared query parameter is not accepted by this endpoint and is always passed as null.\n\npromoter_outcome_status and ha_outcome_status accept no_response, which matches inspections where no\nresponse of that kind has been recorded. is_auto_accepted only takes effect when set to true;\npassing false is ignored rather than returning only inspections that were not auto accepted.\n\nsort_column accepts inspection_date only and is also the default. sort_direction defaults to\ndescending. A page contains up to 25 records. include_total_count defaults to true and the total is\ncapped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not accessible\nreturns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in total (60000 by\ndefault) return 412. A failed swa_code check returns 401. If the overall request timeout has already\nelapsed when these checks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Returns inspections carried out on or after this date and time",
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns inspections carried out on or before this date and time. Must be on or after startDate",
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by the kind of inspection carried out. Values must be unique",
						"in": "query",
						"name": "inspection_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionType"
							}
						}
					},
					{
						"description": "Filter by the outcome the inspector recorded. Values must be unique",
						"in": "query",
						"name": "inspection_outcome",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionOutcome"
							}
						}
					},
					{
						"description": "Returns inspections recorded on or after this date and time",
						"in": "query",
						"name": "start_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns inspections recorded on or before this date and time. Must be on or after startDateCreated",
						"in": "query",
						"name": "end_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The inspection date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/InspectionSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to inspections on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation name; for Planner and Contractor users it searches the highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the reference of the work inspected. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the category the inspection falls into. Values must be unique",
						"in": "query",
						"name": "inspection_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionCategory"
							}
						}
					},
					{
						"description": "Filter by the promoter's response to the outcome. Values must be unique",
						"in": "query",
						"name": "promoter_outcome_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/PromoterInspectionOutcomeStatusType"
							}
						}
					},
					{
						"description": "Filter by the highway authority's response to a disputed outcome. Values must be unique",
						"in": "query",
						"name": "ha_outcome_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/HAInspectionOutcomeStatusType"
							}
						}
					},
					{
						"description": "Set to true to return only inspections whose outcome was accepted automatically because no response was given before the deadline. Setting it to false has no effect",
						"in": "query",
						"name": "is_auto_accepted",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether inspections belonging to additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/inspections/files": {
			"get": {
				"operationId": "GetInspectionFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get inspections for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the list of files attached to a single inspection. inspection_reference_number is required\nand is matched exactly. If no inspection exists with that reference the request returns 404.\n\nAccess is checked against the work the inspection belongs to rather than against the inspection\nitself. Highway Authority users may read the files on any inspection. Planner and Contractor users\nmust be assigned to the workstream of the inspected work, and for Contractor users the promoter\norganisation must not be suspended or disabled. A failed check returns 401.\n\nOnly files that have finished uploading are returned. file_type narrows the list by file extension:\ndocuments covers pdf, doc and docx, and images covers jpg, jpeg, png, gif, tiff and bmp. The two\nvalues are combined with AND rather than OR, so supplying both returns nothing. Files whose extension\nmatches neither category are excluded whenever file_type is supplied.\n\nThis endpoint is not paged and takes no offset; every matching file is returned, ordered by upload\ndate descending. Any unexpected failure, including a database query exceeding the 30 second timeout,\nis logged and returned as 500. If the overall request timeout has already elapsed when validation\ncompletes, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the inspection whose files are being requested. Max length 100 characters",
						"in": "query",
						"name": "inspection_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. The values are combined with AND, so supplying both returns no files, and files whose extension matches neither category are excluded whenever this is supplied. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/workstreams": {
			"get": {
				"operationId": "GetWorkstreams",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkstreamReportingResponse"
								}
							}
						}
					}
				},
				"description": "Returns all workstreams associated with the logged in user's organisation. Optional filter by status\nAuthenticated user must have one of the following roles: Admin\n\nResults are always restricted to the caller's own organisation and are ordered by active status and\nthen by workstream prefix; the ordering is not configurable.",
				"security": [
					{
						"token": [
							"Admin"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the status of the workstream. Values are matched as active or not active, so supplying every status returns the same records as supplying none",
						"in": "query",
						"name": "status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkstreamStatus"
							}
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/reinstatements": {
			"get": {
				"operationId": "GetReinstatements",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReinstatementReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Reinstatements for more information\nReturns all reinstatements associated with the logged in user's organisation. Optional filter by status\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of reinstatements that have been registered, that is the records of how an excavation\nwas made good. A site may hold several reinstatements over time as an interim is replaced by a permanent\none, and by default every one of them is returned; set latest_reinstatements_only to restrict the report to\nthe reinstatement currently in force for each site.\n\nResults are scoped to the caller. Planner users see reinstatements on works belonging to workstreams they\nare a member of. Highway Authority users see reinstatements on works where they are the authority, plus\nworks belonging to any additional organisations they have access to unless include_additional_orgs is set\nto false. Contractor users must supply swa_code and are scoped to the promoter organisation it identifies;\nthe code must belong to an organisation the user may contract for and that organisation must not be\nsuspended or disabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. The registration date pair filters on when the reinstatement\nrecord was created, and the end date pair on the date the reinstatement's guarantee period ends.\n\nTwo work reference filters are offered: work_reference_number matches partially and case-insensitively,\nwhile work_reference_number_exact requires the whole reference. Supplying both applies both.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the reinstatement end date in the direction given by\nsort_direction. Unusually for this API, the default direction is ascending, so the soonest expiry appears\nfirst. Records sharing an end date are then ordered by their internal identifier ascending so that paging\nstays stable. The end date is the only permitted sort column. When include_total_count is left on, the\ntotal is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Column to order results by. The reinstatement end date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ReinstatementSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to ascending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Filter by whether the reinstatement is interim or permanent",
						"in": "query",
						"name": "status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ReinstatementStatus"
							}
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "When true, returns only the reinstatement currently in force for each site. Setting it to false has the same effect as omitting it",
						"in": "query",
						"name": "latest_reinstatements_only",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Returns reinstatements registered on or after this date",
						"in": "query",
						"name": "registration_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements registered on or before this date. Must occur on or after registration_date_from",
						"in": "query",
						"name": "registration_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements whose guarantee period ends on or after this date",
						"in": "query",
						"name": "end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements whose guarantee period ends on or before this date. Must occur on or after end_date_from",
						"in": "query",
						"name": "end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by work reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the whole work reference, case-insensitive. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number_exact",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/reinstatements/expiring-interims": {
			"get": {
				"operationId": "GetExpiringInterimReinstatements",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReinstatementReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Expiring Interim Reinstatements for more information\nReturns expiring interim associated with the logged in user's organisation.\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of interim reinstatements that are still in force, so that promoters can see which\nsites they still need to reinstate permanently and authorities can see what is outstanding against them.\n\nThree restrictions are always applied and cannot be switched off: the reinstatement must be the one\ncurrently in force for its site, it must have interim status, and the site must not have been subsumed\ninto another work. There is therefore no status parameter on this report.\n\nScoping is the same as the main reinstatements report: Planner users are limited to their workstreams,\nHighway Authority users to works they are the authority for plus any additional organisations they have\naccess to, and Contractor users to the promoter identified by swa_code.\n\nUnlike the main reinstatements report, each date pair supplied here must span no more than one year.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the reinstatement end date in the direction given by\nsort_direction, defaulting to ascending so that the soonest expiry appears first. When include_total_count\nis left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Column to order results by. The reinstatement end date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ReinstatementSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to ascending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements registered on or after this date. The pair must span no more than one year",
						"in": "query",
						"name": "registration_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements registered on or before this date. Must occur on or after registration_date_from",
						"in": "query",
						"name": "registration_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements whose interim period ends on or after this date. The pair must span no more than one year",
						"in": "query",
						"name": "end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinstatements whose interim period ends on or before this date. Must occur on or after end_date_from",
						"in": "query",
						"name": "end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by work reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the whole work reference, case-insensitive. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number_exact",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/reinstatements/files": {
			"get": {
				"operationId": "GetReinstatementFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Reinstatement Files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to a single reinstatement, which for reinstatements are usually the photographs\nevidencing how the excavation was made good. Unlike the reinstatement reports this is not a paged report:\nevery matching file is returned in one response, and there are no paging, sorting or total count\nparameters.\n\nreinstatement_reference_number is mandatory. If no reinstatement holds that reference the request is\nrejected as not found. Access is then decided from the work the reinstatement's site belongs to rather than\nfrom the reinstatement itself, so a caller who may read the work may list its reinstatement files.\n\nFiles are matched by filename extension. Supplying file_type therefore excludes any file whose extension\nfalls outside the categories requested, and because the categories are combined with AND rather than OR,\nsupplying both returns no files. Omit file_type to retrieve everything attached to the reinstatement.\n\nAny unexpected failure while retrieving the reinstatement, the work or the files is logged and returned as\na server error.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the reinstatement whose files are required. Max length 100 characters",
						"in": "query",
						"name": "reinstatement_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/forward-plans": {
			"get": {
				"operationId": "GetForwardPlans",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ForwardPlanReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get ForwardPlans for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a page of forward plans visible to the authenticated user.\nPlanner users see forward plans on works in the workstreams they are assigned to within their own\norganisation. Contractor users must supply swa_code identifying the promoter they are acting for;\nthat organisation must exist, must not be suspended or disabled and must hold a contract with the\ncontractor's organisation, and results are limited to that promoter and to the workstreams the\ncontractor is assigned to for it. Highway Authority users see forward plans raised against their\nown organisation, plus any additional organisations they have access to unless include_additional_orgs\nis set to false.\n\nproposed_start_date and proposed_end_date together select forward plans whose own date range\noverlaps the range supplied, whereas work_start_date_from/to and work_end_date_from/to bound the\nforward plan start and end dates individually. forward_plan_reference_number, organisation,\nstreet_descriptor and usrn are all partial matches; street_descriptor is matched as whole words.\nThe shared query parameter is not accepted by this endpoint and is always passed as null.\n\nsort_column accepts start_date and end_date only; when omitted results are ordered by the date the\nforward plan was created. sort_direction defaults to descending. A page contains up to 25 records.\ninclude_total_count defaults to true and the total is capped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not accessible\nreturns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in total (60000 by\ndefault) return 412. A failed swa_code check returns 401. If the overall request timeout has already\nelapsed when these checks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the status of the forward plan. Values must be unique",
						"in": "query",
						"name": "forward_plan_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ForwardPlanStatus"
							}
						}
					},
					{
						"description": "Returns forward plans still running on or after this date and time, that is those whose end date falls on or after it",
						"in": "query",
						"name": "proposed_start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns forward plans that had already started on or before this date and time, that is those whose start date falls on or before it. Must be on or after proposedStartDate",
						"in": "query",
						"name": "proposed_end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns forward plans whose start date is on or after this date and time",
						"in": "query",
						"name": "work_start_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns forward plans whose start date is on or before this date and time. Must be on or after workStartDateFrom",
						"in": "query",
						"name": "work_start_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns forward plans whose end date is on or after this date and time",
						"in": "query",
						"name": "work_end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns forward plans whose end date is on or before this date and time. Must be on or after workEndDateFrom",
						"in": "query",
						"name": "work_end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The start date and the end date are the only options. When omitted results are ordered by the date the forward plan was created",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ForwardPlanSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to forward plans on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation name; for Planner and Contractor users it searches the highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the reference of the forward plan. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "forward_plan_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether forward plans belonging to additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/section-58s": {
			"get": {
				"operationId": "GetSection58s",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section58ReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Section 58s for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of Section 58 restrictions. A Section 58 restriction is imposed by a highway authority\nafter substantial road works, and prevents further works in the street for a set period.\n\nScoping differs from most reports. Highway Authority users see only their own restrictions, plus those of\nany additional organisations they have access to unless include_additional_orgs is set to false. Planner and\nContractor users are not scoped to an organisation at all and see every restriction recorded in the service,\nwhich is intentional because a promoter needs to know about restrictions wherever it plans to work.\n\nEvery filter supplied is combined with AND. start_date_from and start_date_to are applied to the date the\nrestriction comes into force. ha_organisation_name is only applied for Planner and Contractor users; for\nHighway Authority users it is ignored, because their results are already limited to their own organisations.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the date the restriction record was created in the direction\ngiven by sort_direction, which defaults to descending. The creation date is the only permitted sort column.\nWhen include_total_count is left on, the total is capped at 501.\n\nswa_code, organisation and query are not exposed by this endpoint and have no effect.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the name of the authority that imposed the restriction. Partial, case-insensitive matching. Max length 100 characters. Only applied for Planner and Contractor users",
						"in": "query",
						"name": "ha_organisation_name",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns restrictions starting on or after this date",
						"in": "query",
						"name": "start_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns restrictions starting on or before this date. Must occur on or after start_date_from",
						"in": "query",
						"name": "start_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by the status of the restriction",
						"in": "query",
						"name": "section_58_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/Section58Status"
							}
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The creation date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/Section58SortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Restricts results to restrictions whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by restriction reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "section_58_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Partial matching, leading zeros ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether restrictions belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/section-74s": {
			"get": {
				"operationId": "GetSection74s",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section74ReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Section 74s for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of Section 74 overrun warnings and charges. A Section 74 is raised by a highway\nauthority when a promoter's works overrun the agreed end date, and can lead to a daily charge.\n\nResults are scoped to the caller. Planner users see Section 74s on works belonging to workstreams they\nare a member of. Highway Authority users see Section 74s where they are the authority, plus works\nbelonging to any additional organisations they have access to unless include_additional_orgs is set to\nfalse. Contractor users must supply swa_code and are scoped to the promoter organisation it identifies;\nthe code must belong to an organisation the user may contract for and that organisation must not be\nsuspended or disabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. issue_date_from and issue_date_to are applied to the date the\nSection 74 record was created, which is when the overrun warning was issued.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the issue date in the direction given by sort_direction,\nwhich defaults to descending. The issue date is the only permitted sort column. When include_total_count\nis left on, the total is capped at 501.\n\nquery is not exposed by this endpoint and has no effect.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the status the authority has given the Section 74",
						"in": "query",
						"name": "section_74_ha_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/Section74HAStatus"
							}
						}
					},
					{
						"description": "Returns Section 74s issued on or after this date",
						"in": "query",
						"name": "issue_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns Section 74s issued on or before this date. Must occur on or after issue_date_from",
						"in": "query",
						"name": "issue_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The issue date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/Section74SortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by organisation name. For Highway Authority users this searches the promoter name, for Planner and Contractor users the authority name. Max length 100 characters",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Partial matching, leading zeros ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Section 74 reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "section_74_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/section-74s/files": {
			"get": {
				"operationId": "GetSection74Files",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Section 74 files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to a single Section 74, identified by its reference number. Only files that have\nfinished uploading and are ready are returned. The response is a plain list of file identifiers and names;\nit is not paged and carries no total count. Use the file retrieval endpoint to download a file's content.\n\nThe reference must identify an existing Section 74, otherwise the request is rejected as not found.\n\nAccess is decided from the work the Section 74 belongs to rather than from the Section 74 itself. Any\nHighway Authority user is granted access. A Planner user must have read access to the work's workstream.\nA Contractor user must have read access to the work's workstream and the promoter organisation must not be\nsuspended or disabled.\n\nFiles are ordered by their creation date, most recent first. The ordering is not configurable.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the Section 74 whose files are being requested. Max length 100 characters",
						"in": "query",
						"name": "section_74_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. The values are combined with AND, so supplying both returns no files, and files whose extension matches neither category are excluded whenever this is supplied. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/section-81s": {
			"get": {
				"operationId": "GetSection81s",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/Section81ReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Section 81s for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of Section 81s. A Section 81 is raised when a defect is found in a promoter's\napparatus or in works left in the street, and requires the responsible party to put it right.\n\nResults are scoped to the caller. Planner users see Section 81s on works belonging to workstreams they\nare a member of. Highway Authority users see Section 81s where they are the authority, plus works\nbelonging to any additional organisations they have access to unless include_additional_orgs is set to\nfalse. Contractor users must supply swa_code and are scoped to the promoter organisation it identifies;\nthe code must belong to an organisation the user may contract for and that organisation must not be\nsuspended or disabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. issue_date_from and issue_date_to are applied to the date the\nSection 81 record was created; status_changed_date_from and status_changed_date_to are applied to the\ndate its status last changed.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the status changed date in the direction given by\nsort_direction, which defaults to descending. The status changed date is the only permitted sort column.\nWhen include_total_count is left on, the total is capped at 501.\n\nSeverity and the made-safe-by-authority flag are omitted from the response for unattributed works, which\nhave no responsible promoter to assign a severity to. Note that section_81_severity remains usable as a\nfilter for those records even though the value is not returned.\n\nquery is not exposed by this endpoint and has no effect.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the status of the Section 81",
						"in": "query",
						"name": "section_81_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/Section81Status"
							}
						}
					},
					{
						"description": "Filter by the severity assigned to the defect",
						"in": "query",
						"name": "section_81_severity",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/Section81Severity"
							}
						}
					},
					{
						"description": "Returns Section 81s issued on or after this date",
						"in": "query",
						"name": "issue_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns Section 81s issued on or before this date. Must occur on or after issue_date_from",
						"in": "query",
						"name": "issue_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns Section 81s whose status last changed on or after this date",
						"in": "query",
						"name": "status_changed_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns Section 81s whose status last changed on or before this date. Must occur on or after status_changed_date_from",
						"in": "query",
						"name": "status_changed_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The status changed date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/Section81SortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by organisation name. For Highway Authority users this searches the promoter name, for Planner and Contractor users the authority name. Max length 100 characters",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the type of defect reported",
						"in": "query",
						"name": "section_81_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/Section81Type"
							}
						}
					},
					{
						"description": "Filter by street name, matched as whole words. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Partial matching, leading zeros ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Section 81 reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "section_81_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/section-81s/files": {
			"get": {
				"operationId": "GetSection81Files",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Section 81 files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to a single Section 81, identified by its reference number. Only files that have\nfinished uploading and are ready are returned. The response is a plain list of file identifiers and names;\nit is not paged and carries no total count. Use the file retrieval endpoint to download a file's content.\n\nThe reference must identify an existing Section 81, otherwise the request is rejected as not found.\n\nAccess is decided from the work the Section 81 belongs to rather than from the Section 81 itself. Any\nHighway Authority user is granted access. A Planner user must have read access to the work's workstream.\nA Contractor user must have read access to the work's workstream and the promoter organisation must not be\nsuspended or disabled.\n\nFiles are ordered by their creation date, most recent first. The ordering is not configurable.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the Section 81 whose files are being requested. Max length 100 characters",
						"in": "query",
						"name": "section_81_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. The values are combined with AND, so supplying both returns no files, and files whose extension matches neither category are excluded whenever this is supplied. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/csv-exports": {
			"get": {
				"operationId": "GetCsvExports",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/CSVExportReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get CSV Exports for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority, Admin\n\nReturns the CSV export jobs requested by the authenticated user. Results are always restricted to\nthe calling user's own exports; there is no way to view exports requested by another user.\nContractor users must supply swa_code identifying the promoter they are acting for, and results are\nfurther restricted to exports recorded against that promoter organisation. The swa_code must belong\nto an organisation that exists, is not suspended or disabled, and holds a contract with the\ncontractor's organisation, otherwise the request is rejected with an authorisation error.\n\nUnlike the other reporting endpoints this one does not accept the shared reporting parameters.\nOnly offset, swa_code and include_total_count are read; geographical_area_reference_number,\norganisation, street_descriptor, usrn, query and the sort parameters are not accepted. No\ngeographical area existence or USRN constraint checks are performed.\n\nResults are always ordered by date_created descending; ordering cannot be changed.\nA page contains up to 25 records. include_total_count defaults to true and the total is capped at 501.\n\nValidation errors return 400, a failed swa_code check returns 401, and a database query exceeding\nthe 30 second timeout returns 500. If the overall request timeout has already elapsed when the\nvalidation and authorisation checks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority",
							"Admin"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/geographical-areas": {
			"get": {
				"operationId": "GetGeographicalAreas",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"items": {
										"$ref": "#/components/schemas/GeographicalAreaResponse"
									},
									"type": "array"
								}
							}
						}
					}
				},
				"description": "Returns all geographic areas associated with the logged in user's organisation\nAuthenticated user must have one of the following roles: Admin, HighwayAuthority\n\nReturns every geographical area belonging to the organisations the authenticated user can access,\nwhich includes any additional organisations linked to their account. Unlike the reporting endpoints\nthere is no parameter to exclude those additional organisations.\n\nThis endpoint takes no parameters, performs no validation and is not paged. The full list is\nreturned as a plain array rather than a paged reporting response, ordered by area name ascending.\n\nThe reference numbers returned here are the values accepted by the geographical_area_reference_number\nfilter on the reporting endpoints.\n\nA database query exceeding the 30 second timeout returns 500. If the overall request timeout has\nalready elapsed, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Admin",
							"HighwayAuthority"
						]
					}
				],
				"parameters": []
			}
		},
		"/pbi-sample-inspection-targets": {
			"get": {
				"operationId": "GetPbiSampleInspectionTargets",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PbiSampleInspectionTargetReportingResponse"
								}
							}
						}
					}
				},
				"description": "Authenticated user must have one of the following roles: HighwayAuthority, Admin, StreetWorksAdmin\n\nReturns a page of performance based inspection targets. A target records, for one promoter and one\nhighway authority in one financial quarter, the agreed inspection rate, the resulting number of\ncategory A, B and C inspections to be carried out, and how many of each category have been\ncompleted so far. The response also reports how many category B and C samples have actually been\ngenerated against each target.\n\nWhich side of the relationship you see depends on your organisation type. Highway Authority\norganisations see the targets they hold against each promoter, including any additional\norganisations they have access to unless include_additional_orgs is false, and each record is\nlabelled with the promoter organisation. Any other non-contractor organisation sees the targets\nheld against it by each authority, and each record is labelled with the authority instead.\nContractor organisations are refused outright, which this codebase reports as 401 rather than 403.\n\nquarter_start_date selects a financial quarter and must be the first day of a quarter. When it is\nomitted the report returns the currently active targets instead, which is not the same as the\ncurrent quarter if targets for a quarter have not yet been activated.\n\nThis endpoint does not build on the shared reporting request, so swa_code,\ngeographical_area_reference_number, organisation, street_descriptor, usrn and query are not\naccepted. sort_column accepts is_inspection_rate_auto_updated only and has no default; results are\nalways finally ordered by organisation name, which is the only ordering applied when no sort column\nis supplied. A page contains up to 25 records. include_total_count defaults to true and the total is\ncapped at 501.\n\nValidation errors return 400. A quarter_start_date that is a valid quarter start but has no\nmatching financial quarter returns 412. If the overall request timeout has already elapsed the\nrequest returns an empty response body before validation runs. Any unexpected failure while\nretrieving the targets is logged and returned as 500.",
				"security": [
					{
						"token": [
							"HighwayAuthority",
							"Admin",
							"StreetWorksAdmin"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Selects the financial quarter to report on. Must be the first day of a quarter. When omitted the currently active targets are returned, which is not necessarily the current quarter",
						"in": "query",
						"name": "quarter_start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Column to order results by. Only the inspection rate auto updated flag is accepted and there is no default; results are always finally ordered by organisation name",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PbiSampleInspectionTargetSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Only applied when a sort column is supplied",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether targets belonging to additional organisations they have access to are included. Defaults to true. Has no effect for other organisation types",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/pbi-sample-inspections": {
			"get": {
				"operationId": "GetPbiSampleInspections",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PbiSampleInspectionReportingResponse"
								}
							}
						}
					}
				},
				"description": "Authenticated user must have one of the following roles: HighwayAuthority\n\nReturns a page of works that have been selected for performance based inspection sampling and are\nstill awaiting inspection. Each record identifies the work, the promoter responsible for it, the\ninspection category the sample falls into and the date by which the sample inspection must be\ncarried out. The report always filters to samples whose status is issued, so samples that have been\ncompleted or cancelled are never returned and there is no status parameter.\n\nOnly Highway Authority users may call this report, and results are limited to works in their own\narea, plus any additional organisations they have access to unless include_additional_orgs is\nfalse.\n\nsample_expiry_date_from and sample_expiry_date_to bound the date by which the sample inspection is\ndue. work_reference_number, organisation, street_descriptor and usrn are all partial matches;\norganisation searches the promoter organisation name, street_descriptor is matched as whole words\nand usrn ignores leading zeros. The shared query parameter is not accepted by this endpoint and is\nalways passed as null. swa_code is validated but has no effect, because only Highway Authority\nusers may call this report.\n\nsort_column accepts work_end_date and sample_expiry_date and defaults to sample_expiry_date.\nUnusually for this API, sort_direction defaults to ascending, so by default the samples closest to\nexpiry appear first. A page contains up to 25 records. include_total_count defaults to true and the\ntotal is capped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not\naccessible returns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in total\n(60000 by default) return 412. If the overall request timeout has already elapsed when these checks\ncomplete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Accepted and validated but has no effect on this report. The SWA code exists so Contractor users can identify the promoter they are acting for, and Contractor users cannot call this report. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to samples on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Direction to order results in. Defaults to ascending, unlike most other reports",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Filter by the name of the promoter responsible for the works. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the reference of the work sampled. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns samples due to be inspected on or after this date",
						"in": "query",
						"name": "sample_expiry_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns samples due to be inspected on or before this date. Must be on or after sampleExpiryDateFrom",
						"in": "query",
						"name": "sample_expiry_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Column to order results by. The sample expiry date and the work end date are the options. Defaults to the sample expiry date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PbiSampleInspectionSortColumn"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Whether samples belonging to additional organisations the caller has access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/works/files": {
			"get": {
				"operationId": "GetWorkFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get work files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to a single work, identified by its work reference number. These are the files\nrecorded against the work itself rather than against one of its permits, inspections or reinstatements.\nOnly files that have finished uploading and are ready are returned. The response is a plain list of file\nidentifiers and names; it is not paged and carries no total count. Use the file retrieval endpoint to\ndownload a file's content.\n\nThe reference must identify an existing work, otherwise the request is rejected as not found.\n\nAny Highway Authority user is granted access. A Planner user must have read access to the work's\nworkstream. A Contractor user must have read access to the work's workstream and the promoter\norganisation must not be suspended or disabled. The Admin role is admitted by the controller's security\ndecorator but is always refused by the access check, so in practice it cannot call this endpoint.\n\nFiles are ordered by their creation date, most recent first. The ordering is not configurable.",
				"security": [
					{
						"token": [
							"Admin",
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the work whose files are being requested. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. The values are combined with AND, so supplying both returns no files, and files whose extension matches neither category are excluded whenever this is supplied. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/works": {
			"get": {
				"operationId": "GetWorks",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/WorkSearchReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get works for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nLooks up works by work reference number. This is a type-ahead style search intended to help a user pick a\nwork, not a reporting endpoint: work_reference_number is mandatory, matching is partial and\ncase-insensitive, and at most 5 works are returned. The response is a plain list with no paging, no\noffset and no total count, so a reference that matches widely silently returns an arbitrary 5.\n\nResults are scoped to the caller. Planner users see works promoted by their own organisation that also\nbelong to a workstream they are a member of. Contractor users must supply swa_code and are scoped the same\nway against the promoter organisation it identifies; the code must belong to an organisation the user may\ncontract for and that organisation must not be suspended or disabled, otherwise the request is refused.\nHighway Authority users see works where they are the authority, plus works belonging to any additional\norganisations they have access to unless include_additional_orgs is set to false.\n\nUnlike getWorkFiles, this method narrows the controller's security decorator to exclude the Admin role.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The work reference to search for. Mandatory, partial and case-insensitive. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/reinspections": {
			"get": {
				"operationId": "GetReinspections",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ReinspectionReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get reinspections for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of reinspections that are due. A reinspection is an inspection a highway authority has\nscheduled to revisit a work, typically to confirm that a defect found at an earlier inspection has been put\nright.\n\nThis is a forward-looking to-do list of inspections still to be carried out, not a record of inspections\nalready completed. Use the inspections report for those.\n\nResults are scoped to the caller. Planner users see reinspections on works belonging to workstreams they\nare a member of. Highway Authority users see reinspections on works where they are the authority, plus\nworks belonging to any additional organisations they have access to unless include_additional_orgs is set\nto false. Contractor users must supply swa_code and are scoped to the promoter organisation it identifies;\nthe code must belong to an organisation the user may contract for and that organisation must not be\nsuspended or disabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. The start_date and end_date pair is applied to the reinspection\ndate, using the scheduled time where one was recorded and the date alone where it was not.\n\nIf geographical_area_reference_number is supplied, every reference must exist and be accessible to the\ncaller, and the areas combined must not exceed the configured maximum number of USRNs (60000 by default).\n\nA page contains at most 25 records, ordered by the reinspection date in the direction given by\nsort_direction, which defaults to descending. The reinspection date is the only permitted sort column.\nWhen include_total_count is left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Returns reinspections due on or after this date",
						"in": "query",
						"name": "start_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns reinspections due on or before this date. Must occur on or after start_date",
						"in": "query",
						"name": "end_date",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by the type of inspection that has been scheduled",
						"in": "query",
						"name": "inspection_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionType"
							}
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The reinspection date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ReinspectionSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by work reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the category of inspection that has been scheduled",
						"in": "query",
						"name": "inspection_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionCategory"
							}
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/private-street-notices": {
			"get": {
				"operationId": "GetPrivateStreets",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PrivateStreetReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Private Street Notices for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a paged list of private street notices, which are the notices promoters give before carrying out\nworks on a street that is not publicly maintainable.\n\nResults are scoped to the caller. Planner users see notices on works belonging to workstreams they are a\nmember of. Highway Authority users see notices on works where they are the authority, plus works belonging\nto any additional organisations they have access to unless include_additional_orgs is set to false.\nContractor users must supply swa_code and are scoped to the promoter organisation it identifies; the code\nmust belong to an organisation the user may contract for and that organisation must not be suspended or\ndisabled, otherwise the request is refused.\n\nEvery filter supplied is combined with AND. The three date pairs filter on the proposed start date, the\nproposed end date and the date the notice was created respectively.\n\nIf geographical_area_reference_number is supplied the areas combined must not exceed the configured maximum\nnumber of USRNs (60000 by default). Unlike most reporting endpoints, the references themselves are not\nchecked for existence or accessibility, so an unknown reference simply matches nothing.\n\nA page contains at most 25 records, ordered by sort_column and sort_direction, defaulting to the notice\ncreation date descending. When include_total_count is left on, the total is capped at 501.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Column to order results by. Defaults to the notice creation date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PrivateStreetNoticeSortColumn"
						}
					},
					{
						"description": "Filter by promoter or highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name, matched as whole words",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by Unique Street Reference Number. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by private street notice reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "private_street_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns notices whose proposed start date falls on or after this date",
						"in": "query",
						"name": "start_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices whose proposed start date falls on or before this date. Must occur on or after start_date_from",
						"in": "query",
						"name": "start_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices whose proposed end date falls on or after this date",
						"in": "query",
						"name": "end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices whose proposed end date falls on or before this date. Must occur on or after end_date_from",
						"in": "query",
						"name": "end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices created on or after this date",
						"in": "query",
						"name": "date_created_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns notices created on or before this date. Must occur on or after date_created_from",
						"in": "query",
						"name": "date_created_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by notice status",
						"in": "query",
						"name": "private_street_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/PrivateStreetStatus"
							}
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether works belonging to additional organisations they have access to are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/private-street-notices/files": {
			"get": {
				"operationId": "GetPrivateStreetFiles",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/FileSummaryReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Private Street Notice Files for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns the files attached to a single private street notice. Unlike the notices report this is not a paged\nreport: every matching file is returned in one response, and there are no paging, sorting or total count\nparameters.\n\nprivate_street_reference_number is mandatory. If no notice holds that reference the request is rejected as\nnot found. Access is then decided from the work the notice belongs to rather than from the notice itself,\nso a caller who may read the work may list its notice files.\n\nFiles are matched by filename extension. Supplying file_type therefore excludes any file whose extension\nfalls outside the categories requested, and because the categories are combined with AND rather than OR,\nsupplying both returns no files. Omit file_type to retrieve everything attached to the notice.\n\nAny unexpected failure while retrieving the notice, the work or the files is logged and returned as a\nserver error.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "The reference of the private street notice whose files are required. Max length 100 characters",
						"in": "query",
						"name": "private_street_reference_number",
						"required": true,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Narrows the list by file extension. Values must be unique",
						"in": "query",
						"name": "file_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/FileType"
							}
						}
					}
				]
			}
		},
		"/non-compliances": {
			"get": {
				"operationId": "GetNonCompliances",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/NonComplianceReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get non compliances for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a page of non compliances — records raised by a highway authority when works have failed to\nmeet the required standard, together with the promoter's and the authority's responses and any\njoint site meeting arranged to resolve them. Each non compliance also carries a summary of the most\nrecent inspection associated with it, which the most_recent_inspection_* filters act on.\n\nPlanner users see non compliances on works in the workstreams they are assigned to within their own\norganisation. Contractor users must supply swa_code identifying the promoter they are acting for;\nthat organisation must exist, must not be suspended or disabled and must hold a contract with the\ncontractor's organisation, and results are limited to that promoter and to the workstreams the\ncontractor is assigned to for it. Highway Authority users see non compliances raised against works\nin their own area, plus any additional organisations they have access to unless\ninclude_additional_orgs is false.\n\nnon_compliance_date_created_from and non_compliance_date_created_to bound the date the non\ncompliance was raised. non_compliance_reference_number, organisation, street_descriptor and usrn\nare all partial matches; street_descriptor is matched as whole words and usrn ignores leading\nzeros. The shared query parameter is accepted by the request model but is not applied by this\nreport.\n\npromoter_response_status, most_recent_inspection_promoter_response_status and\nmost_recent_inspection_ha_response_status accept no_response, which is mapped to null and matches\nrecords where no response of that kind has been recorded. ha_response_status does not receive the\nsame treatment: it is mapped straight through to the reference list, which has no no_response\nmember, so supplying no_response yields an undefined value and the query fails rather than\nreturning non compliances awaiting a highway authority response.\n\nThe most recent inspection is joined with a left outer join, so a non compliance with no associated\ninspection is still returned until one of the most_recent_inspection_* filters is supplied.\n\nsort_column accepts date_created only and is also the default. sort_direction defaults to\ndescending. A page contains up to 25 records. include_total_count defaults to true and the total is\ncapped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not\naccessible returns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in total\n(60000 by default) return 412. A failed swa_code check returns 401. If the overall request timeout\nhas already elapsed when these checks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Returns non compliances raised on or after this date and time",
						"in": "query",
						"name": "non_compliance_date_created_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns non compliances raised on or before this date and time. Must be on or after nonComplianceDateCreatedFrom",
						"in": "query",
						"name": "non_compliance_date_created_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by the reference of the non compliance. Partial, case-insensitive matching. Max length 106 characters",
						"in": "query",
						"name": "non_compliance_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the status of the non compliance. Values must be unique",
						"in": "query",
						"name": "non_compliance_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/NonComplianceStatus"
							}
						}
					},
					{
						"description": "Filter by the highway authority's latest response. Values must be unique. Unlike the other response filters this one does not accept no_response; supplying it causes the query to fail rather than returning non compliances awaiting a highway authority response",
						"in": "query",
						"name": "ha_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/NonComplianceResponseStatus"
							}
						}
					},
					{
						"description": "Filter by the promoter's latest response. Values must be unique. Accepts no_response to match records where no promoter response has been recorded",
						"in": "query",
						"name": "promoter_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/NonComplianceResponseStatus"
							}
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to non compliances on works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation name; for Planner and Contractor users it searches the highway authority organisation name",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The creation date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/NonComplianceSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Filter by the kind of the most recent associated inspection. Values must be unique. Supplying this excludes non compliances with no associated inspection",
						"in": "query",
						"name": "most_recent_inspection_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionType"
							}
						}
					},
					{
						"description": "Filter by the outcome of the most recent associated inspection. Values must be unique. Supplying this excludes non compliances with no associated inspection",
						"in": "query",
						"name": "most_recent_inspection_outcome",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/InspectionOutcome"
							}
						}
					},
					{
						"description": "Filter by the promoter's response to the most recent associated inspection. Values must be unique. Accepts no_response to match records where no such response has been recorded",
						"in": "query",
						"name": "most_recent_inspection_promoter_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/PromoterInspectionOutcomeStatusType"
							}
						}
					},
					{
						"description": "Filter by the highway authority's response to the most recent associated inspection. Values must be unique. Accepts no_response to match records where no such response has been recorded",
						"in": "query",
						"name": "most_recent_inspection_ha_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/HAInspectionOutcomeStatusType"
							}
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether non compliances belonging to additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/material-classifications": {
			"get": {
				"operationId": "GetMaterialClassifications",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/MaterialClassificationReportingResponse"
								}
							}
						}
					}
				},
				"description": "See API specification Resource Guide > Reporting API > Get Material Classifications for more information\nAuthenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority\n\nReturns a page of material classification samples — records of excavated material that has been\nsampled and classified as hazardous or non hazardous. material_classification_classification is\nmandatory, so every call reports on one classification or the other and never both. When hazardous\nis requested the response additionally carries the hazardous material types recorded against each\nsample, aggregated from the sample's material type links.\n\nUnlike every other reporting endpoint this report applies no organisation, workstream or\ngeographical area scoping: material_classification is not joined to work, so the same records are\nvisible to every authenticated caller regardless of role or organisation.\n\ndate_sample_taken_from and date_sample_taken_to bound the date the sample was taken, while\ndate_created_from and date_created_to bound the date the record was created.\nmaterial_classification_reference_number is a partial, case-insensitive match. street_descriptor is\nmatched as whole words against the sample's own street descriptor and usrn is a partial match that\nignores leading zeros; both are applied to columns on material_classification rather than on work.\n\nThe shared swa_code, geographical_area_reference_number, organisation, query, sort_column and\ninclude_additional_orgs parameters are not accepted by this endpoint. There is no sort column: the\nreport always orders by the date the record was created, with sort_direction defaulting to\ndescending. A page contains up to 25 records. include_total_count defaults to true and the total is\ncapped at 501.\n\nValidation errors return 400. Because no geographical area or SWA code filtering applies, this\nendpoint raises neither the 404 resource check nor the 412 constraint check used elsewhere. If the\noverall request timeout has already elapsed when validation completes, an empty response body is\nreturned.",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending. Results are always ordered by the date the record was created",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Filter by the reference of the sample. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "material_classification_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to report on hazardous or non hazardous samples. Mandatory, so every call reports on one classification and never both",
						"in": "query",
						"name": "material_classification_classification",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/MaterialClassificationClassification"
						}
					},
					{
						"description": "Returns samples taken on or after this date",
						"in": "query",
						"name": "date_sample_taken_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns samples taken on or before this date. Must be on or after dateSampleTakenFrom",
						"in": "query",
						"name": "date_sample_taken_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns records created on or after this date",
						"in": "query",
						"name": "date_created_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns records created on or before this date. Must be on or after dateCreatedFrom",
						"in": "query",
						"name": "date_created_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/pbi-sample-generation-jobs": {
			"get": {
				"operationId": "GetPbiSampleGenerationJobs",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PbiSampleGenerationJobsReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged list of the performance based inspection sample generation jobs raised by the\nauthenticated user's own organisation, most recently created first.\n\nAccess: authenticated user must have one of the following roles: Admin, StreetWorksAdmin. The user's\norganisation must additionally be a highway authority; callers from any other type of organisation are\nrefused. Results are always restricted to jobs raised by the caller's own organisation and cannot be\nwidened to other organisations.\n\nSee API specification Resource Guide > Reporting API > Get PBI Sample Generation Jobs for more information",
				"security": [
					{
						"token": [
							"Admin",
							"StreetWorksAdmin"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/interested-party-permits": {
			"get": {
				"operationId": "GetInterestedPartyPermits",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/PermitReportingResponse"
								}
							}
						}
					}
				},
				"description": "Authenticated user must have the following role: HighwayAuthority\n\nReturns a page of permits on works where the authenticated user's organisation has been recorded\nas an interested party. Scoping is driven entirely by that interested party link rather than by\nworkstream membership or by the promoter and highway authority on the work, so a user sees the\npermits for works their organisation has been invited to follow and nothing else. Any additional\norganisations the user has access to are included as well, unless include_additional_orgs is\nfalse.\n\nwork_start_date_from and work_start_date_to bound permit.permit_start_date, work_end_date_from and\nwork_end_date_to bound permit.permit_end_date, and start_date_created and end_date_created bound\npermit.date_created. The work_ prefixes describe the works the permit covers, not columns on the\nwork record itself.\n\npermit_reference_number, promoter_organisation_name, ha_organisation_name, street_descriptor and\nusrn are all partial matches; street_descriptor is matched as whole words and usrn ignores leading\nzeros. work_reference_number is applied against permit.permit_reference_number rather than the\nwork reference, so it behaves as a second permit reference filter. The shared query, organisation\nand swa_code parameters are not accepted by this endpoint and are always passed as null.\n\nis_high_impact_traffic_management is applied in both directions: true returns only permits whose\ncurrent version uses a high impact traffic management type, false returns only those that do not.\n\nsort_column accepts the full permit sort column list and defaults to date_created; sort_direction\ndefaults to descending. A page contains up to 25 records. include_total_count defaults to true and\nthe total is capped at 501.\n\nValidation errors return 400. A geographical area reference that does not exist or is not\naccessible returns 404, and geographical areas covering more than MAX_GEO_AREA_USRNS USRNs in\ntotal (60000 by default) return 412. If the overall request timeout has already elapsed when these\nchecks complete, an empty response body is returned.",
				"security": [
					{
						"token": [
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. Accepts the full permit sort column list and defaults to the creation date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/PermitSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Restricts results to works whose street falls within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by permit reference. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "permit_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Despite its name this is matched against the permit reference rather than the work reference, so it behaves as a second permit reference filter and a genuine work reference will usually return nothing. Max length 100 characters",
						"in": "query",
						"name": "work_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose authorised period starts on or after this date",
						"in": "query",
						"name": "work_start_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose authorised period starts on or before this date. Must be on or after workStartDateFrom",
						"in": "query",
						"name": "work_start_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose authorised period ends on or after this date",
						"in": "query",
						"name": "work_end_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits whose authorised period ends on or before this date. Must be on or after workEndDateFrom",
						"in": "query",
						"name": "work_end_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits created on or after this date",
						"in": "query",
						"name": "start_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns permits created on or before this date. Must be on or after startDateCreated",
						"in": "query",
						"name": "end_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by the status of the work the permit belongs to. Values must be unique",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by the category of works the permit covers. Values must be unique",
						"in": "query",
						"name": "work_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkCategory"
							}
						}
					},
					{
						"description": "Filter by whether the permit uses a high impact traffic management type. Unusually for this API both true and false are applied",
						"in": "query",
						"name": "is_high_impact_traffic_management",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the name of the organisation promoting the works. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "promoter_organisation_name",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the name of the highway authority for the works. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "ha_organisation_name",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Whether works where an additional organisation you have access to is the interested party are included. Defaults to true",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/change-requests": {
			"get": {
				"operationId": "GetChangeRequests",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ChangeRequestReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of permit change requests.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nContractor users must supply swa_code identifying the promoter they are acting for, and that promoter\norganisation must exist, must not be suspended or disabled, and must have a contract with the contractor's\nown organisation, otherwise access is refused. Planner users only see change requests on works in the\nworkstreams they are assigned to within their own organisation; Contractor users only see change requests\non works promoted by the organisation identified by swa_code and within the workstreams they are assigned\nto for that organisation; Highway Authority users only see change requests on works where their own\norganisation is the highway authority, plus any additional organisations they have access to unless\ninclude_additional_orgs is set to false. Every geographical area reference supplied must exist and be\naccessible to the caller's organisation, otherwise the request is rejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum\nnumber of USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Change Requests for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Filter by the current status of the change request. Values must be unique",
						"in": "query",
						"name": "change_request_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ChangeRequestStatus"
							}
						}
					},
					{
						"description": "Filter by what kind of change request it is. Values must be unique",
						"in": "query",
						"name": "change_request_type",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ChangeRequestType"
							}
						}
					},
					{
						"description": "Filter by the work category recorded on the permit at the time the change request was raised. Values must be unique",
						"in": "query",
						"name": "work_category",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkCategory"
							}
						}
					},
					{
						"description": "Returns change requests created on or after this date and time",
						"in": "query",
						"name": "start_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns change requests created on or before this date and time. Must be on or after startDateCreated",
						"in": "query",
						"name": "end_date_created",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The creation date, the deadline date and the status changed date are the options. Defaults to the creation date",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ChangeRequestSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "Set to true to return only change requests raised against traffic sensitive works. Setting it to false has no effect; omit it to return all change requests",
						"in": "query",
						"name": "is_traffic_sensitive",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "Set to true to return only change requests raised against works using high impact traffic management. Setting it to false has no effect",
						"in": "query",
						"name": "is_high_impact_traffic_management",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to streets that fall within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Returns change requests whose status last changed on or after this date and time",
						"in": "query",
						"name": "status_update_date_from",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Returns change requests whose status last changed on or before this date and time. Must be on or after statusUpdateDateFrom",
						"in": "query",
						"name": "status_update_date_to",
						"required": false,
						"schema": {
							"format": "date-time",
							"type": "string"
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation; for Planner and Contractor users it searches the highway authority organisation",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the change request's reference number. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "change_request_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether records from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		},
		"/change-requests/duration-challenges": {
			"get": {
				"operationId": "GetChangeRequestDurationChallenges",
				"responses": {
					"200": {
						"description": "Ok",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ChangeRequestDurationChallengeReportingResponse"
								}
							}
						}
					}
				},
				"description": "Retrieves a paged, filterable list of permit change requests that have been granted with a duration\nchallenge, together with the review and non-acceptance response recorded against each one.\n\nAccess: authenticated user must have one of the following roles: Planner, Contractor, HighwayAuthority.\nContractor users must supply swa_code identifying the promoter they are acting for, and that promoter\norganisation must exist, must not be suspended or disabled, and must have a contract with the contractor's\nown organisation, otherwise access is refused. Planner users only see change requests on works in the\nworkstreams they are assigned to within their own organisation; Contractor users only see change requests\non works promoted by the organisation identified by swa_code and within the workstreams they are assigned\nto for that organisation; Highway Authority users only see change requests on works where their own\norganisation is the highway authority, plus any additional organisations they have access to unless\ninclude_additional_orgs is set to false. Every geographical area reference supplied must exist and be\naccessible to the caller's organisation, otherwise the request is rejected as not found.\nBusiness constraints: the geographical areas supplied must not cover more than the configured maximum\nnumber of USRNs in total (60000 by default).\n\nSee API specification Resource Guide > Reporting API > Get Change Request Duration Challenges for more information",
				"security": [
					{
						"token": [
							"Planner",
							"Contractor",
							"HighwayAuthority"
						]
					}
				],
				"parameters": [
					{
						"description": "Number of records to skip before the page begins. 0 or greater",
						"in": "query",
						"name": "offset",
						"required": false,
						"schema": {
							"format": "double",
							"type": "number"
						}
					},
					{
						"description": "Column to order results by. The status changed date is the only option and is also the default",
						"in": "query",
						"name": "sort_column",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/ChangeRequestDurationChallengeSortColumn"
						}
					},
					{
						"description": "Direction to order results in. Defaults to descending",
						"in": "query",
						"name": "sort_direction",
						"required": false,
						"schema": {
							"$ref": "#/components/schemas/SortDirection"
						}
					},
					{
						"description": "The SWA code of the promoter a Contractor user is acting on behalf of. Required for Contractor users and ignored for all other roles. Max length 4 characters",
						"in": "query",
						"name": "swa_code",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by organisation name. Partial, case-insensitive matching. Max length 100 characters. For Highway Authority users this searches the promoter organisation; for Planner and Contractor users it searches the highway authority organisation",
						"in": "query",
						"name": "organisation",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Restricts results to streets that fall within the given geographical areas. References must be unique, must exist and must be accessible to the caller. The areas combined must not cover more than the configured maximum number of USRNs (60000 by default)",
						"in": "query",
						"name": "geographical_area_reference_number",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"type": "string"
							}
						}
					},
					{
						"description": "Filter by the promoter's response to the duration challenge. Values must be unique",
						"in": "query",
						"name": "duration_challenge_review_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeReviewStatus"
							}
						}
					},
					{
						"description": "Filter by the authority's response where the promoter did not accept the challenge. Values must be unique",
						"in": "query",
						"name": "duration_challenge_non_acceptance_response_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/DurationChallengeNonAcceptanceResponseStatus"
							}
						}
					},
					{
						"description": "Filter by the status of the work the change request belongs to. Values must be unique",
						"in": "query",
						"name": "work_status",
						"required": false,
						"schema": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/WorkStatus"
							}
						}
					},
					{
						"description": "Filter by street name. Matched as whole words rather than as a fragment of a word. Max length 100 characters",
						"in": "query",
						"name": "street_descriptor",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the Unique Street Reference Number of the street. Partial matching is supported and leading zeros are ignored. Max length 100 characters",
						"in": "query",
						"name": "usrn",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Filter by the change request's reference number. Partial, case-insensitive matching. Max length 100 characters",
						"in": "query",
						"name": "change_request_reference_number",
						"required": false,
						"schema": {
							"type": "string"
						}
					},
					{
						"description": "Whether to calculate the total number of matching records. Defaults to true. The total is capped at 501. Turning it off avoids a second query",
						"in": "query",
						"name": "include_total_count",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					},
					{
						"description": "For Highway Authority users, whether records from additional organisations they have access to are included. Defaults to true. Has no effect for Planner and Contractor users",
						"in": "query",
						"name": "include_additional_orgs",
						"required": false,
						"schema": {
							"type": "boolean"
						}
					}
				]
			}
		}
	},
	"servers": [
		{
			"url": "/"
		}
	]
}