action tfl_road_disruption_by_id {
  label: "Gets a list of active disruptions filtered by disruption Ids."
  provider: tfl
  method: GET
  path: "/Road/all/Disruption/{disruptionIds}"
  encoding: json
  input: {
    type: "object"
    properties: {
      disruptionIds: {
        type: "array"
        items: {
          type: "string"
        }
      }
      stripContent: {
        type: "boolean"
      }
    }
    required: ["disruptionIds"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      category: {
        type: "string"
        description: "Describes the nature of disruption e.g. Traffic Incidents, Works"
      }
      comments: {
        type: "string"
        description: "Full text of comments describing the disruption, including details of any road closures and diversions, where appropriate."
      }
      corridorIds: {
        type: "array"
        description: "The Ids of affected corridors, if any."
        items: {
          type: "string"
        }
      }
      currentUpdate: {
        type: "string"
        description: "Text of the most recent update from the LSTCC on the state of the
\n             disruption, including the current traffic impact and any advice to
\n             road users."
      }
      currentUpdateDateTime: {
        type: "string"
        format: "date-time"
        description: "The time when the last CurrentUpdate description was recorded, 
\n            or null if no CurrentUpdate has been applied."
      }
      endDateTime: {
        type: "string"
        format: "date-time"
        description: "The date and time on which the disruption ended. For planned disruptions, this date will have a valid value. For unplanned 
\n            disruptions in progress, this field will be omitted."
      }
      geography: {
        type: "object"
        properties: {
          geography: {
            type: "object"
            properties: {
              coordinateSystemId: {
                type: "integer"
                format: "int32"
              }
              wellKnownBinary: {
                type: "string"
                format: "byte"
              }
              wellKnownText: {
                type: "string"
              }
            }
          }
        }
      }
      geometry: {
        type: "object"
        additionalProperties: true
      }
      hasClosures: {
        type: "boolean"
        description: "True if any of the affected Streets have a \"Full Closure\" status, false otherwise. A RoadDisruption that has HasClosures is considered a 
\n            Severe or Serious disruption for severity filtering purposes."
      }
      id: {
        type: "string"
        description: "Unique identifier for the road disruption"
      }
      isProvisional: {
        type: "boolean"
        description: "True if the disruption is planned on a future date that is open to change"
      }
      lastModifiedTime: {
        type: "string"
        format: "date-time"
        description: "The date and time on which the disruption was last modified in the system. This information can reliably be used by a developer to quickly
\n            compare two instances of the same disruption to determine if it has been changed."
      }
      levelOfInterest: {
        type: "string"
        description: "This describes the level of potential impact on traffic operations of the disruption. 
\n            High = e.g. a one-off disruption on a major or high profile route which will require a high level of operational attention 
\n            Medium = This is the default value 
\n            Low = e.g. a frequently occurring disruption which is well known"
      }
      linkText: {
        type: "string"
        description: "The text of any associated link"
      }
      linkUrl: {
        type: "string"
        description: "The url of any associated link"
      }
      location: {
        type: "string"
        description: "Main road name / number (borough) or preset area name where the disruption is located. This might be useful for a map popup where space is limited."
      }
      ordinal: {
        type: "integer"
        format: "int32"
        description: "An ordinal of the disruption based on severity, level of interest and corridor."
      }
      point: {
        type: "string"
        description: "Latitude and longitude (WGS84) of the centroid of the disruption, stored in a geoJSON-formatted string."
      }
      publishEndDate: {
        type: "string"
        format: "date-time"
      }
      publishStartDate: {
        type: "string"
        format: "date-time"
        description: "TDM Additional properties"
      }
      recurringSchedules: {
        type: "array"
        items: {
          type: "object"
          properties: {
            endTime: {
              type: "string"
              format: "date-time"
            }
            startTime: {
              type: "string"
              format: "date-time"
            }
          }
        }
      }
      roadDisruptionImpactAreas: {
        type: "array"
        items: {
          type: "object"
          properties: {
            endDate: {
              type: "string"
              format: "date-time"
            }
            endTime: {
              type: "string"
            }
            id: {
              type: "integer"
              format: "int32"
            }
            polygon: {
              type: "object"
              additionalProperties: true
            }
            roadDisruptionId: {
              type: "string"
            }
            startDate: {
              type: "string"
              format: "date-time"
            }
            startTime: {
              type: "string"
            }
          }
        }
      }
      roadDisruptionLines: {
        type: "array"
        items: {
          type: "object"
          properties: {
            endDate: {
              type: "string"
              format: "date-time"
            }
            endTime: {
              type: "string"
            }
            id: {
              type: "integer"
              format: "int32"
            }
            isDiversion: {
              type: "boolean"
            }
            multiLineString: {
              type: "object"
              additionalProperties: true
            }
            roadDisruptionId: {
              type: "string"
            }
            startDate: {
              type: "string"
              format: "date-time"
            }
            startTime: {
              type: "string"
            }
          }
        }
      }
      roadProject: {
        type: "object"
        properties: {
          boroughsBenefited: {
            type: "array"
            items: {
              type: "string"
            }
          }
          constructionEndDate: {
            type: "string"
            format: "date-time"
          }
          constructionStartDate: {
            type: "string"
            format: "date-time"
          }
          consultationEndDate: {
            type: "string"
            format: "date-time"
          }
          consultationPageUrl: {
            type: "string"
          }
          consultationStartDate: {
            type: "string"
            format: "date-time"
          }
          contactEmail: {
            type: "string"
          }
          contactName: {
            type: "string"
          }
          cycleSuperhighwayId: {
            type: "string"
          }
          externalPageUrl: {
            type: "string"
          }
          phase: {
            type: "string"
            enum: ["Unscoped", "Concept", "ConsultationEnded", "Consultation", "Construction", "Complete"]
          }
          projectDescription: {
            type: "string"
          }
          projectId: {
            type: "string"
          }
          projectName: {
            type: "string"
          }
          projectPageUrl: {
            type: "string"
          }
          projectSummaryPageUrl: {
            type: "string"
          }
          schemeName: {
            type: "string"
          }
        }
      }
      severity: {
        type: "string"
        description: "A description of the severity of the disruption."
      }
      startDateTime: {
        type: "string"
        format: "date-time"
        description: "The date and time which the disruption started. For a planned disruption (i.e. planned road works) this date will be in the future.
\n            For unplanned disruptions, this will default to the date on which the disruption was first recorded, but may be adjusted by the operator."
      }
      status: {
        type: "string"
        description: "This describes the status of the disruption.  
\n            Active = currently in progress 
\n            Active Long Term = currently in progress and long term
\n            Scheduled = scheduled to start within the next 180 days
\n            Recurring Works = planned maintenance works that follow a regular routine or pattern and whose next occurrence is to start within the next 180 days.
\n            Recently Cleared = recently cleared in the last 24 hours
\n            Note that the status of Scheduled or Recurring Works disruptions will change to Active when they start, and will change status again when they end."
      }
      streets: {
        type: "array"
        description: "A collection of zero or more streets affected by the disruption."
        items: {
          type: "object"
          properties: {
            closure: {
              type: "string"
              description: "Type of road closure. Some example values:
\n            Open = road is open, not blocked, not closed, not restricted. It maybe that the disruption has been moved out of the carriageway.
\n            Partial Closure = road is partially blocked, closed or restricted. 
\n            Full Closure = road is fully blocked or closed."
            }
            directions: {
              type: "string"
              description: "The direction of the disruption on the street. Some example values:
\n            All Directions
\n            All Approaches
\n            Clockwise
\n            Anti-Clockwise
\n            Northbound
\n            Eastbound
\n            Southbound
\n            Westbound
\n            Both Directions"
            }
            name: {
              type: "string"
              description: "Street name"
            }
            segments: {
              type: "array"
              description: "Geographic description of the sections of this street that are affected."
              items: {
                type: "object"
                properties: {
                  lineString: {
                    type: "string"
                    description: "geoJSON formatted LineString containing two latitude/longitude (WGS84) pairs that identify the start and end points of the street segment."
                  }
                  sourceSystemId: {
                    type: "integer"
                    format: "int64"
                    description: "The ID from the source system of the disruption that this street belongs to."
                  }
                  sourceSystemKey: {
                    type: "string"
                    description: "The key of the source system of the disruption that this street belongs to."
                  }
                  toid: {
                    type: "string"
                    description: "A 16 digit unique integer identifying a OS ITN (Ordnance Survey Integrated Transport Network) road link."
                  }
                }
              }
            }
            sourceSystemId: {
              type: "integer"
              format: "int64"
              description: "The ID from the source system of the disruption that this street belongs to."
            }
            sourceSystemKey: {
              type: "string"
              description: "The key of the source system of the disruption that this street belongs to."
            }
          }
        }
      }
      subCategory: {
        type: "string"
        description: "Describes the sub-category of disruption e.g. Collapsed Manhole, Abnormal Load"
      }
      timeFrame: {
        type: "string"
      }
      url: {
        type: "string"
        description: "URL to retrieve this road disruption"
      }
    }
  }
}