Key differences between V4 and V5

This document details the key differences between V4 API and V5 API. This is not an exhaustive list. For more detail see the Versions and changes

Key differences:

  1. Private streets have been added. More information here.
  2. Sample inspections:
    • We have added a new Endpoint: /previous-annual-inspection-units to retrieve the last three years worth of annual inspection unit information. More information here.
    • We have have updated sample inspection create and update endpoints. Properties changed to no longer accept inspection_units_year_one through to inspection_units_year_three. Instead, the property annual_inspection_units is to be provided as an array containing the following properties:
      • financial_year_start_date - The start date of the target's FY
      • annual_inspection_units - Annual inspection units for that FY
      • is_auto_calculated - Should match the boolean value returned via /previous-annual-inspection-units
  3. Current traffic management endpoint has been updated. More information here.
  4. Changes to inspections:
    • New outcome statuses have been added. More information here. Business rules relating to the inspetion types can be found here. The new types are:
      • Joint site meeting needed
      • Reviewing dispute
      • No agreement
      • Inspection withdrawn
    • New investigatory works type has been added. More information here.
    • We have added auto acceptance due information being returned. See the InspectionResponse in swagger
  5. You can now link a permit during the creation of a site/reinstatement. More information here.
  6. Revert end quarter functionality has been added. More information here.
  7. We have split inspection and reinspection endpoints. More information on inspections here and reinspections here.
  8. New Inspection categories section_81_initial and section_81_follow_up will be added before V5 is stabilised. These will be set automatically by the system when Section 81 inspections are recorded.
  9. Regular works records now cannot have section_81 inspections or reinspections recorded against them.
  10. Section 81 works records now can only have section_81 inspections or reinspections recorded against them.
  11. New permit status under_assessment will be added before V5 is stabilised. This will be set by the PUT /works/{workReferenceNumber}/permits/{permitReferenceNumber}/under-assessment endpoint and will stop immediate permits from being Granted (Auto) before being assessed by a Highway Authority. More information here.