Key differences between V5 and V6

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

Key differences:

  1. Change request re-design (v2). More information here.
  2. New fields added to the requests to support Clash and collaboration management. Applies to POST /work, POST /works/{workReferenceNumber}/permits and POST /works/{workReferenceNumber/permits/{permitReferenceNumber}/alterations to support collaboration management that will be validated if the existing collaborative_working field is set to true. {: .govuk-body} Fields relating to collaboration management. {: .govuk-body}
    1. is_primary_promoter?: null | boolean - Required if collaborative_working === true - Used to indicate if you are the Primary or Secondary promoter collaborating.
    2. collaboration_types?: null | CollaborationType[] - Required if collaborative_working === true or others_can_collaborate_on_work === true - Uses the existing CollaborationType enum but now an array rather than a single value.
    3. primary_promoter_permit_reference_number?: null | string - If secondary promoter (is_primary_promoter = false) then this is used to link to the Primary promoter permit (if known). As this will cause a link between the two permits the PRN must be for a permit that exists - NOTE: In V5 collaborative_works was used to provide the work reference number.
    4. collaboration_contact_name?: null | string - Required if collaborative_working === true or others_can_collaborate_on_work === true - Contact info relating to the collaboration, it is required if either collaborative_working or is_primary_promoter is provided.
    5. collaboration_contact_email?: null | string - Contact info relating to the collaboration, at least one of collaboration_contact_email or collaboration_contact_phone_number is required if collaborative_working is true or others_can_collaborate_on_work is true.
    6. collaboration_contact_phone_number?: null | string - Contact info relating to the collaboration, at least one of collaboration_contact_email or collaboration_contact_phone_number is required if collaborative_working is true or others_can_collaborate_on_work is true.
    7. estimated_number_of_network_days_saved?: null | number - Required if secondary promoter (is_primary_promoter = false).
    8. others_can_collaborate_on_work?: null | boolean - Can be used to indicate if the permit is available for collaboration.
    9. reason_for_non_collaboration?: null | string - Required if others_can_collaborate_on_work is false.
    10. can_collaborate_on_work_additional_details?: null | string - Required if others_can_collaborate_on_work is true.
  3. New fields added to the WorkResponse (active_permit), PermitResponse and PermitAlterationResponse (original and proposed) to support collaboration management. {: .govuk-body}
  4. New potential_clash_with_other_works?: null | boolean field added to the PermitResponse to support clash management, if there were clashes detected on the USRN - See GET /potential-clashes endpoint.
  5. New GET /potential-clashes endpoint to check if there are other works on as specific USRN between the proposed dates. It accepts usrn, start_date and end_date as mandatory query params and returns an array of work_reference_number, start_date and end_date (limited to 25).
  6. Section 81 reassign now creates a new work record for the relevant org. Section81Status enum now had a reassigned, value. More information here.