openapi: 3.0.0 info: title: Miovision Open Data API description: | The Miovision Open Data API endpoints facilitate the retrieval of intersection and organization related information. They provide access to various functionalities such as retrieving active alerts, available cameras at an intersection, fetching camera snapshots, checking diagnostics for communication and detection devices, managing priority requests at traffic intersections, retrieving TMC data, and travel time information. Each endpoint is parameterized and handles potential authorization and resource not found errors. To access the API you need an API key. If your organization does not have an API key, contact Customer Support to request an API key. Unless otherwise specified, dates and times are in ISO 8601 format. For example, 2017-08-30T14:32:00+05:00. Dates and times are returned based on the time zone specified by your organization in Miovision One. To learn more about the data output each method generates, click the Show/Hide link next to it. You can complete these steps to preview the response a method will return: 1. Click Authorize and type the API key into the box that pops up. The API key only needs to be authorized once. Enter the API key that Miovision provided you. If you do not have an API key, you can request one from Miovision. After you click Authorize, you can run any of the methods in the API. 2. Click on the API you're interested in and then click Try it out! Under the method that you want to try, type any required parameters and then click Try it out! To clear your authorization, refresh the page. version: 1.0.0 tags: - {name: Alerts, description: Operations relating to Alerts} - {name: Cameras, description: Operations relating to Cameras} - {name: Diagnostics, description: Operations relating to Diagnostics} - {name: Intersections, description: Operations relating to Intersections} - {name: Organizations, description: Operations relating to Organizations} - {name: Priority Requests, description: Operations relating to Priority (including Preemption) Requests} - {name: TMC, description: Operations relating to Turning Moving Counts} - {name: Median Travel Time, description: Operations relating to Median Travel Time} - {name: Users, description: Operations relating to Users} - {name: Safety, description: Operations relating to Safety} servers: - {url: 'https://api.miovision.one'} security: - ApiKeyAuth: [] paths: /v1/alerts: get: summary: Retrieve all active Alerts description: | Returns the requested `pageNumber` (default: `0`) of `pageSize` (default: `100`, maximum: `1000`) Alerts active at the time of the request, and optionally between `startDateTime` (default: now) and `endDateTime` (default: now). Set `includeShared` to `true` to also return Alerts for intersections shared with the organization. **Note**: Pages are 0-indexed. tags: [Alerts] operationId: getAlertsV1 parameters: - {$ref: '#/components/parameters/startDateTimeAlerts'} - {$ref: '#/components/parameters/endDateTimeAlerts'} - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSizeWithMax'} - {$ref: '#/components/parameters/includeShared'} responses: '200': {$ref: '#/components/responses/GetAlertsResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidStartDateTime` | Start time has to be before end time | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} /v1/intersections: get: summary: Retrieve all Intersections. description: | Returns the requested `pageNumber` (default: `0`) of `pageSize` (default: `100`) Intersections for the Organization in which the User is currently active. **Note**: Pages are 0-indexed. tags: [Intersections] operationId: getIntersectionsV1 parameters: - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSize'} - {$ref: '#/components/parameters/includeShared'} responses: '200': {$ref: '#/components/responses/GetIntersectionsResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} /v1/intersections/hardware: get: tags: [Intersections] summary: Retrieve hardware information for all Intersections with hardware description: | Returns the requested `pageNumber` (default: `0`) of `pageSize` (default: `100`) Intersection hardware for the Organization in which the User is currently active. **Note**: Pages are 0-indexed. operationId: getIntersectionsHardwareV1 parameters: - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSize'} responses: '200': {$ref: '#/components/responses/GetIntersectionsHardwareResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} /v1/intersections/{intersectionId}: get: summary: Retrieve the specified Intersection description: Returns the Intersection identified by `{intersectionId}`. tags: [Intersections] operationId: getIntersectionV1 parameters: - {$ref: '#/components/parameters/intersectionId'} responses: '200': {$ref: '#/components/responses/GetIntersectionResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} /v1/intersections/{intersectionId}/cameras: get: summary: Retrieve all Cameras available for the specified Intersection. description: | Returns the requested `pageNumber` (default: `0`) of `pageSize` (default: `100`) Cameras available in the Intersection identified with `{intersectionId}`. The Cameras that are available in an Intersection may be SmartView 360 cameras or Snapshot Camera peripherals. The ID returned may be passed to the `getCameraSnapshotV1` operation to retrieve a live snapshot from that Camera. **Note**: Pages are 0-indexed. tags: [Cameras] operationId: getCamerasV1 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSize'} responses: '200': {$ref: '#/components/responses/GetCamerasResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} /v1/intersections/{intersectionId}/cameras/{cameraId}/snapshot: get: summary: Retrieve a Snapshot from the specified Camera in the specified Intersection description: | Returns a binary image Snapshot (usually JPEG) from the Camera identified by `{cameraId}` in the Intersection identified by `{intersectionId}`. **Note:** The `Accept` header with value `image/jpeg` is required. tags: [Cameras] operationId: getCameraSnapshotV1 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/cameraId'} responses: '200': {$ref: '#/components/responses/GetCameraSnapshotResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v1/intersections/{intersectionId}/communicationDevices/diagnostics: get: summary: Retrieve Communication Device Diagnostics for the specified Intersection description: | Returns the Communication Device's diagnostic status for the Intersection identified by `{intersectionId}`. tags: [Diagnostics] operationId: getCommunicationDeviceDiagnosticsV1 parameters: - {$ref: '#/components/parameters/intersectionId'} responses: '200': {$ref: '#/components/responses/GetCommunicationDeviceDiagnosticsResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | The requested resource was not found. Ensure the correct identifier was provided.
Error code returned in JSON: | Error code | Description | |-------------------------------|--------------------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `IntersectionDeviceNotFound` | Unable to find devices for intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} /v1/intersections/{intersectionId}/detectionDevices/diagnostics: get: summary: Retrieve the diagnostics of Detection Devices in the specified Intersection. description: Returns the diagnostics of Detection Devices in the Intersection identified by `{intersectionId}` tags: [Diagnostics] operationId: getDetectionDeviceDiagnosticsV1 parameters: - {$ref: '#/components/parameters/intersectionId'} responses: '200': {$ref: '#/components/responses/GetDetectionDeviceDiagnosticsResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | The requested resource was not found. Ensure the correct identifier was provided.
Error code returned in JSON: | Error code | Description | |-------------------------------|-------------------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `IntersectionDeviceNotFound` | Unable to find devices for intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} /v1/organizations/{organizationId}/intersections/{intersectionId}/timingPlans: get: tags: [Intersections] deprecated: true summary: Get all timing plan revisions for an intersection (deprecated) description: | Returns all timing plan revisions (draft and deployed) for the specified intersection. Deprecated on September 15, 2026 and scheduled for retirement on December 15, 2026. Migrate to `GET /v2/intersections/{intersectionId}/timingPlans` before the sunset date. operationId: getIntersectionTimingPlansV1 parameters: - {$ref: '#/components/parameters/organizationId'} - {$ref: '#/components/parameters/intersectionId'} responses: '200': description: Successfully retrieved timing plans headers: Deprecation: description: Date on which this endpoint is deprecated, expressed as a Unix timestamp. schema: {type: string, example: '@1789430400'} Sunset: description: Date after which this endpoint will no longer be available. schema: {type: string, example: 'Tue, 15 Dec 2026 00:00:00 GMT'} Link: description: Link to the successor endpoint. schema: {type: string, example: '; rel="successor-version"'} content: application/json: schema: type: array items: {$ref: '#/components/schemas/TimingPlan'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} /v2/intersections/{intersectionId}/timingPlans: get: tags: [Intersections] summary: Get timing plan summaries for an intersection description: | Returns a page of metadata for the intersection's deployed timing plan revisions. By default, revisions are ordered from newest to oldest. Use `pageNumber` and `pageSize` to navigate the results. Use `sort` to change the order by creation time. Each result contains metadata only. To retrieve the complete timing plan for a revision, use its `id` as `timingPlanId` with `GET /v2/intersections/{intersectionId}/timingPlans/{timingPlanId}`. operationId: getIntersectionTimingPlansV2 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/timingPlanPageSize'} - {$ref: '#/components/parameters/timingPlanSort'} responses: '200': description: Successfully retrieved timing plan summaries content: application/json: schema: {$ref: '#/components/schemas/TimingPlansPageView'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} /v1/organizations/{organizationId}/intersections/{intersectionId}/timingPlans/{timingPlanId}: get: tags: [Intersections] deprecated: true summary: Get a specific timing plan by ID (deprecated) description: | Returns a single timing plan revision by its ID. Deprecated on September 15, 2026 and scheduled for retirement on December 15, 2026. Migrate to `GET /v2/intersections/{intersectionId}/timingPlans/{timingPlanId}` before the sunset date. operationId: getIntersectionTimingPlanByIdV1 parameters: - {$ref: '#/components/parameters/organizationId'} - {$ref: '#/components/parameters/intersectionId'} - name: timingPlanId in: path required: true description: The unique identifier of the timing plan schema: {type: string} responses: '200': description: Successfully retrieved timing plan headers: Deprecation: description: Date on which this endpoint is deprecated, expressed as a Unix timestamp. schema: {type: string, example: '@1789430400'} Sunset: description: Date after which this endpoint will no longer be available. schema: {type: string, example: 'Tue, 15 Dec 2026 00:00:00 GMT'} Link: description: Link to the successor endpoint. schema: {type: string, example: '; rel="successor-version"'} content: application/json: schema: {$ref: '#/components/schemas/TimingPlan'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v2/intersections/{intersectionId}/timingPlans/{timingPlanId}: get: tags: [Intersections] summary: Get a specific timing plan by ID description: Returns a complete timing plan revision by its ID. operationId: getIntersectionTimingPlanByIdV2 parameters: - {$ref: '#/components/parameters/intersectionId'} - name: timingPlanId in: path required: true description: The unique identifier of the timing plan schema: {type: string} responses: '200': description: Successfully retrieved timing plan content: application/json: schema: {$ref: '#/components/schemas/TimingPlan'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v1/organizations/{organizationId}/intersections/{intersectionId}/timingPlans/latest: get: tags: [Intersections] deprecated: true summary: Get the latest timing plan from the controller (deprecated) description: | Returns the most recent timing plan that was retrieved from the intersection controller. Deprecated on September 15, 2026 and scheduled for retirement on December 15, 2026. Migrate to `GET /v2/intersections/{intersectionId}/timingPlans/latest` before the sunset date. operationId: getIntersectionLatestTimingPlanV1 parameters: - {$ref: '#/components/parameters/organizationId'} - {$ref: '#/components/parameters/intersectionId'} responses: '200': description: Successfully retrieved latest timing plan headers: Deprecation: description: Date on which this endpoint is deprecated, expressed as a Unix timestamp. schema: {type: string, example: '@1789430400'} Sunset: description: Date after which this endpoint will no longer be available. schema: {type: string, example: 'Tue, 15 Dec 2026 00:00:00 GMT'} Link: description: Link to the successor endpoint. schema: {type: string, example: '; rel="successor-version"'} content: application/json: schema: {$ref: '#/components/schemas/TimingPlan'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v2/intersections/{intersectionId}/timingPlans/latest: get: tags: [Intersections] summary: Get the latest timing plan from the controller description: Returns the most recent timing plan that was retrieved from the intersection controller. operationId: getIntersectionLatestTimingPlanV2 parameters: - {$ref: '#/components/parameters/intersectionId'} responses: '200': description: Successfully retrieved latest timing plan content: application/json: schema: {$ref: '#/components/schemas/TimingPlan'} '403': {$ref: '#/components/responses/UnauthorizedResourceException'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v1/intersections/{intersectionId}/hardware/detectionConfiguration: get: tags: [Intersections] summary: Retrieve hardware configuration history for the Intersection identified by `{intersectionId}`. description: | Returns the current and all historic hardware configurations for the specified intersection. The response contains the lastUpdated timestamp (ms since Epoch), a SHA-1 hash value of the configurations for validation, and a base64 encoded json blob of the configurations. **Note**: The format of Intersection Hardware configurations is internal to Miovision and is subject to change at any time without warning. operationId: getIntersectionHardwareConfigurationsV1 parameters: - {$ref: '#/components/parameters/intersectionId'} responses: '200': {$ref: '#/components/responses/GetIntersectionsHardwareConfigurationsResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} /v1/intersections/{intersectionId}/hiresdata: get: summary: Retrieve Intersection Telemetry in High Resolution Data Logger Output Format description: |- Returns telemetry data from the intersection in the [HiRes Data Format](https://docs.lib.purdue.edu/cgi/viewcontent.cgi?article=1002&context=jtrpdata). TrafficLink supports the following event codes: * 0 (Phase On) * 1 (Phase Begin Green) * 7 (Phase Green Termination) * 8 (Phase Begin Yellow Clearance) * 9 (Phase End Yellow Clearance) * 10 (Phase Begin Red Clearance) * 11 (Phase End Red Clearance) * 12 (Phase Inactive) * 21 (Pedestrian Begin Walk) * 22 (Pedestrian Begin Clearance) * 23 (Pedestrian Begin Solid Don't Walk) * 61 (Overlap Begin Green) * 63 (Overlap Begin Yellow) * 64 (Overlap Begin Red Clearance) * 65 (Overlap Off) * 81 (Detector Off) * 82 (Detector On) * 89 (PedDetector Off) * 90 (PedDetector On) Requests must be for one hour or less. tags: [Intersections] operationId: getIntersectionHiresdataV1 parameters: - {$ref: '#/components/parameters/endDateTimeHiRes'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTimeHiRes'} responses: '200': {$ref: '#/components/responses/GetHiResDataResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-------------------------------------------------------------------| | `InvalidStartDateTime` | The value of endDateTime must be later than that of startDateTime | | `InvalidDuration` | Queries must be for at most 1 hour of data at a time | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} /v1/intersections/{intersectionId}/notes: parameters: - {$ref: '#/components/parameters/intersectionId'} get: summary: Retrieve Notes for the specified Intersection. description: Retrieve Notes saved to the Intersection identified by `{intersectionId}`. tags: [Intersections] operationId: getIntersectionNotesV1 responses: '200': {$ref: '#/components/responses/GetIntersectionNotesResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} put: summary: Create or update Notes for a given intersection. description: Adds or updates Notes for the Intersection identified by `{intersectionId}`. operationId: putIntersectionNotesV1 tags: [Intersections] requestBody: {$ref: '#/components/requestBodies/UpsertNotesRequest'} responses: '200': {$ref: '#/components/responses/PutIntersectionNotesResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': {$ref: '#/components/responses/ResourceNotFoundException'} /v1/intersections/{intersectionId}/safety/simpleDelay: get: summary: Retrieves Simple Delay Data for the specified Intersection description: | Returns the following simple delay data for the Intersection identified by `{intersectionId}`: * Median Delay (s) per movement. * Average Delay (s) per movement. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. **Notes**: * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. * When a bin's time frame does not have relevant data it will not be present in the response. tags: [Safety] operationId: getIntersectionSimpleDelayV1 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} responses: '200': {$ref: '#/components/responses/GetIntersectionSimpleDelayResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/safety/redLightRunners: get: summary: Retrieves yellow and red light runner counts for an intersection description: | Returns the following crossing data for the Intersection identified by `{intersectionId}`: * red-light runner count * yellow-light runner count By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. **Notes**: * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [Safety] operationId: getIntersectionRedLightRunnersV1 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} responses: '200': {$ref: '#/components/responses/GetIntersectionRedLightRunnersResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|--------------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Longer than 48 hours between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/safety/pedCompliance: get: summary: Retrieves pedestrian crossing count, and state of ped light when crossing occurred, in binned units of time description: | Returns the following pedestrian crossing data for the Intersection identified by `{intersectionId}`: * red-light (don't-walk) crossing count * yellow-light (flashing-don't-walk) crossing count * total-light crossing count (green + yellow + red) By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. **Notes**: * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [Safety] operationId: getIntersectionPedComplianceV1 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} responses: '200': {$ref: '#/components/responses/GetIntersectionPedComplianceResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|--------------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Longer than 48 hours between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/safety/conflicts: get: summary: Retrieves conflict/near miss events for the specified Intersection deprecated: true description: | **Deprecated:** this endpoint returns event timestamps in **UTC**. Use `GET /v2/intersections/{intersectionId}/safety/conflicts` (operationId `getIntersectionConflictsV2`) instead, which returns event timestamps in the Organization's local timezone. Retrieves conflict/near miss events between the specified start and end times for the Intersection identified by `{intersectionId}`. Such events occur when the trajectories between two road users (e.g. vehicles, pedestrians, cyclists) match the criteria to categorize them as a conflict, which include proximity, speed, movement direction, and more. **Note:** Event timestamps are returned in UTC (`Z`). tags: [Safety] operationId: getIntersectionConflictsV1 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSize'} - {$ref: '#/components/parameters/severityLevels'} - {$ref: '#/components/parameters/roadUserTypesLeading'} - {$ref: '#/components/parameters/roadUserTypesLagging'} - {$ref: '#/components/parameters/configurations'} responses: '200': {$ref: '#/components/responses/GetIntersectionConflictsResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|--------------------------------------------------| | `InvalidStartDateTime` | Start time has to be before end time | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v2/intersections/{intersectionId}/safety/conflicts: get: summary: Retrieves conflict/near miss events for the specified Intersection description: | Retrieves conflict/near miss events between the specified start and end times for the Intersection identified by `{intersectionId}`. Such events occur when the trajectories between two road users (e.g. vehicles, pedestrians, cyclists) match the criteria to categorize them as a conflict, which include proximity, speed, movement direction, and more. This is the v2 replacement for `GET /v1/intersections/{intersectionId}/safety/conflicts`. The only difference is that response timestamps are returned in the **Organization's local timezone** (matching the Miovision One dashboard) rather than UTC. **Notes**: * Event timestamps are returned in the **Organization's local timezone** (e.g. `…-05:00`). * Request timestamps remain ISO-8601 instants and may use any valid offset. tags: [Safety] operationId: getIntersectionConflictsV2 parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSize'} - {$ref: '#/components/parameters/severityLevels'} - {$ref: '#/components/parameters/roadUserTypesLeading'} - {$ref: '#/components/parameters/roadUserTypesLagging'} - {$ref: '#/components/parameters/configurations'} responses: '200': {$ref: '#/components/responses/GetIntersectionConflictsResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|--------------------------------------| | `InvalidStartDateTime` | Start time has to be before end time | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection or Organization timezone not found.
Error code returned in JSON: | Error code | Description | |------------------------|--------------------------------------------------| | `IntersectionNotFound` | Unable to find the requested intersection | | `OrganizationNotFound` | Unable to resolve the Organization timezone | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-----------------|------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/tmc: get: summary: Retrieves TMC Data for the specified Intersection deprecated: true description: | **Deprecated:** this endpoint returns timestamps in **UTC**, which does not match the Organization's timezone shown in Miovision One. Use `GET /v2/intersections/{intersectionId}/tmc` (operationId `getIntersectionTmcV2`) instead, which returns timestamps in the Organization's local timezone. This endpoint is retained unchanged for backwards compatibility with existing integrations. Returns the following TMC data for the Intersection identified by `{intersectionId}`: * the number of vehicles that SmartSense detected in the configured zones * where they came from * their direction of travel * their class. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. By default, all vehicle classes are included. To limit which classes are returned, add a `vehicleClasses` (Array of Strings) parameter to the querystring. Valid vehicle classes include: [`Pedestrian`, `Bicycle`, `Light`, `WorkVan`, `SingleUnitTruck`, `ArticulatedTruck`, `Bus`] **Notes**: * Timestamps are returned in **UTC** (`Z`). For Organization-local timestamps, use the v2 endpoint. * To minimize the file size, the results do not include bins (minutes) with no detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [TMC] operationId: getIntersectionTmcV1 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/vehicleClasses'} responses: '200': {$ref: '#/components/responses/GetIntersectionTmcResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/tmc/crosswalk: get: summary: Retrieve TMC data for the crosswalks at the specified Intersection deprecated: true description: | **Deprecated:** this endpoint returns timestamps in **UTC**, which does not match the Organization's timezone shown in Miovision One. Use `GET /v2/intersections/{intersectionId}/tmc/crosswalk` (operationId `getCrosswalkTmcV2`) instead, which returns timestamps in the Organization's local timezone. This endpoint is retained unchanged for backwards compatibility with existing integrations. Returns the following TMC data for crosswalks at the Intersection identified by `{intersectionId}`: * number of pedestrians that went through * which side they crossed on * which direction they were going * their class. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. Crosswalk TMC data only includes `Pedestrian` and `Bicycle` vehicle classes. To limit which classes are returned, add a `vehicleClasses` parameter with either value. **Notes**: * Timestamps are returned in **UTC** (`Z`). For Organization-local timestamps, use the v2 endpoint. * To minimize the file size, the results do not include bins (minutes) with no pedestrian detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now tags: [TMC] operationId: getCrosswalkTmcV1 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/crosswalkVehicleClasses'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} responses: '200': {$ref: '#/components/responses/GetCrosswalkTmcResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection not found. Returned if there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/tmc/csv: get: summary: Retrieves TMC data for the specified intersection in CSV format description: | Returns a CSV file containing the following TMC data for the Intersection identified by `{intersectionId}`: * the number of vehicles that SmartSense detected in the configured zones * where they came from * their direction of travel * their class. **Notes**: * To minimize the file size, the results do not include bins (minutes) with no detections * The start and end dates of the query must both be on the same day in the Organization's timezone * The end time of the query must be at least 15 minutes before now. * All vehicle classes are included tags: [TMC] operationId: getIntersectionTmcCsvV1 parameters: - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} responses: '200': {$ref: '#/components/responses/GetIntersectionTmcCsvResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-----------------------------|---------------------------------------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidInputException` | Start time and end time must be the same day in the organization timezone | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Organization not found that is associated with the user or there is no intersection with the given ID.
Error code returned in JSON: | Error code | Description | |-----------------------------|----------------------------------------------------------------------------------------------------------| | `ResourceNotFoundException` | Unable to find intersection with id: UUID or the organization not found that is associated with the user | '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/tmc/lanes: get: summary: TMC by lane data for the intersection deprecated: true description: | **Deprecated:** this endpoint returns timestamps in **UTC**, which does not match the Organization's timezone shown in Miovision One. Use `GET /v2/intersections/{intersectionId}/tmc/lanes` (operationId `getIntersectionTmcLanesV2`) instead, which returns timestamps in the Organization's local timezone. This endpoint is retained unchanged for backwards compatibility with existing integrations. Returns the following TMC by lane data in the Intersection identified by `{intersectionId}`: * the number of vehicles that SmartSense detected in the configured zones * where they came from, including which lane * their direction of travel * their class. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. By default, all vehicle classes are included. To limit which classes are returned, add a `vehicleClasses` (Array of Strings) parameter to the querystring. Valid vehicle classes include: [`Pedestrian`, `Bicycle`, `Light`, `WorkVan`, `SingleUnitTruck`, `ArticulatedTruck`, `Bus`] **Notes**: * Timestamps are returned in **UTC** (`Z`). For Organization-local timestamps, use the v2 endpoint. * To minimize the file size, the results do not include bins (minutes) with no detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [TMC] operationId: getIntersectionTmcLanesV1 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/vehicleClasses'} responses: '200': {$ref: '#/components/responses/GetIntersectionTmcLanesResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v2/intersections/{intersectionId}/tmc: get: summary: Retrieves TMC Data for the specified Intersection description: | Returns the following TMC data for the Intersection identified by `{intersectionId}`: * the number of vehicles that SmartSense detected in the configured zones * where they came from * their direction of travel * their class. This is the v2 replacement for `GET /v1/intersections/{intersectionId}/tmc`. The only difference is that response timestamps are returned in the **Organization's local timezone** (matching the Miovision One dashboard) rather than UTC. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. By default, all vehicle classes are included. To limit which classes are returned, add a `vehicleClasses` (Array of Strings) parameter to the querystring. Valid vehicle classes include: [`Pedestrian`, `Bicycle`, `Light`, `WorkVan`, `SingleUnitTruck`, `ArticulatedTruck`, `Bus`] **Notes**: * Timestamps are returned in the **Organization's local timezone** (e.g. `…-05:00`). * To minimize the file size, the results do not include bins (minutes) with no detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [TMC] operationId: getIntersectionTmcV2 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/vehicleClasses'} responses: '200': {$ref: '#/components/responses/GetIntersectionTmcResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection or organization not found. Returned if there is no intersection with the given ID, or its organization has no configured timezone.
Error code returned in JSON: | Error code | Description | |------------------------|----------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `OrganizationNotFound` | Unable to resolve the organization timezone | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v2/intersections/{intersectionId}/tmc/crosswalk: get: summary: Retrieve TMC data for the crosswalks at the specified Intersection description: | Returns the following TMC data for crosswalks at the Intersection identified by `{intersectionId}`: * number of pedestrians that went through * which side they crossed on * which direction they were going * their class. This is the v2 replacement for `GET /v1/intersections/{intersectionId}/tmc/crosswalk`. The only difference is that response timestamps are returned in the **Organization's local timezone** (matching the Miovision One dashboard) rather than UTC. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. Crosswalk TMC data only includes `Pedestrian` and `Bicycle` vehicle classes. To limit which classes are returned, add a `vehicleClasses` parameter with either value. **Notes**: * Timestamps are returned in the **Organization's local timezone** (e.g. `…-05:00`). * To minimize the file size, the results do not include bins (minutes) with no pedestrian detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now tags: [TMC] operationId: getCrosswalkTmcV2 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/crosswalkVehicleClasses'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} responses: '200': {$ref: '#/components/responses/GetCrosswalkTmcResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection or organization not found. Returned if there is no intersection with the given ID, or its organization has no configured timezone.
Error code returned in JSON: | Error code | Description | |------------------------|----------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `OrganizationNotFound` | Unable to resolve the organization timezone | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v2/intersections/{intersectionId}/tmc/lanes: get: summary: TMC by lane data for the intersection description: | Returns the following TMC by lane data in the Intersection identified by `{intersectionId}`: * the number of vehicles that SmartSense detected in the configured zones * where they came from, including which lane * their direction of travel * their class. This is the v2 replacement for `GET /v1/intersections/{intersectionId}/tmc/lanes`. The only difference is that response timestamps are returned in the **Organization's local timezone** (matching the Miovision One dashboard) rather than UTC. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. By default, all vehicle classes are included. To limit which classes are returned, add a `vehicleClasses` (Array of Strings) parameter to the querystring. Valid vehicle classes include: [`Pedestrian`, `Bicycle`, `Light`, `WorkVan`, `SingleUnitTruck`, `ArticulatedTruck`, `Bus`] **Notes**: * Timestamps are returned in the **Organization's local timezone** (e.g. `…-05:00`). * To minimize the file size, the results do not include bins (minutes) with no detections * Each query is limited to 48 hours * The end time of the query must be at least 15 minutes before now. tags: [TMC] operationId: getIntersectionTmcLanesV2 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/startDateTime'} - {$ref: '#/components/parameters/vehicleClasses'} responses: '200': {$ref: '#/components/responses/GetIntersectionTmcLanesResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | | `InvalidStartDateTime` | Start time has to be before end time | | `InvalidDuration` | Too long duration between start and end times | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Intersection or organization not found. Returned if there is no intersection with the given ID, or its organization has no configured timezone.
Error code returned in JSON: | Error code | Description | |------------------------|----------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `OrganizationNotFound` | Unable to resolve the organization timezone | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/organizations/{organizationId}: get: tags: [Organizations] summary: Retrieve organization by id. description: Returns organization Object. operationId: getOrganizationV1 parameters: - {$ref: '#/components/parameters/organizationId'} responses: '200': {$ref: '#/components/responses/GetOrganizationResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure organization exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------------------| | `OrganizationNotFound` | Unable to find organization with organizationId: UUID | '500': {$ref: '#/components/responses/GeneralException'} /v1/intersections/{intersectionId}/priorityCapabilities: parameters: - {$ref: '#/components/parameters/intersectionId'} get: summary: Retrieve the Priority Capabilities of the specified Intersection. description: Provides a method to determine the configuration & capabilities of the intersection. tags: [Priority Requests] operationId: getPriorityCapabilitiesV1 responses: '200': {$ref: '#/components/responses/GetPriorityCapabilitiesResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------|-------------------------------------| | `InvalidFilter` | The path parameter provided is invalid.| content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/priorityRequests: parameters: - {$ref: '#/components/parameters/intersectionId'} get: summary: Retrieve all Priority Requests received by the system for the specified Intersection description: | Returns the requested `pageNumber` (default: `0`) of `pageSize` (default: `100`, maximum: `1000`) Priority Requests. Results can be filtered to include only Priority Requests that are currently open by setting the `isOpen` querystring parameter to `true`. Results can be filtered by date and time using `startDateTime` and `endDateTime` query string parameters. Providing only `startDateTime` will search from that date onwards and providing only `endDateTime` will search up to that date. Using both parameters will filter results within the specified range. Without these parameters, all results are included without date restrictions. **Note**: Pages are 0-indexed. tags: [Priority Requests] operationId: getPriorityRequestsV1 parameters: - {$ref: '#/components/parameters/pageNumber'} - {$ref: '#/components/parameters/pageSizeWithMax'} - {$ref: '#/components/parameters/startDateTimePriority'} - {$ref: '#/components/parameters/endDateTimePriority'} - {$ref: '#/components/parameters/isOpen'} responses: '200': {$ref: '#/components/responses/GetPriorityRequestsResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------|-------------------------------------| | `InvalidFilter` | The path or query parameters provided are invalid.| content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} post: summary: Create a new Priority Request at the specified Intersection description: | It is assumed that the time to apply is the time the request is made. If not manually cleared or updated by the Priority Request Generator (PRG), the request will time out 'timeToLive' seconds after the request is made. If a 200 OK response is received, this is confirmation that the controller has acknowledged the request in NTCIP mode, or that the output has been turned "on" in discrete output mode. Before calling this endpoint, you may wish to call the capabilities endpoint to ensure priority control is supported at this intersection. `msgId`, `tripId`, `obuId` are fields left to the caller to define. They will be tracked and made available in logs and future reporting endpoints. Miovision will treat these as opaque identifiers. Priority requests sent for discrete output will use the vehicleClass as the channel to actuate. Prioritisation is left up to the controller. tags: [Priority Requests] operationId: createPriorityRequestV1 requestBody: {$ref: '#/components/requestBodies/CreatePriorityRequest'} responses: '200': {$ref: '#/components/responses/CreatePriorityRequestResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------------------|-------------------------------------| | `InvalidFilter` | The path parameter provided is invalid. | | `ValidationSingleBadArgument` | Argument is invalid. | | `InvalidRequestException` | The provided request is invalid. | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure intersection exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '405': description: | Priority requests are unsupported at this intersection. Use the capabilities endpoint to determine what is available.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `PriorityRequestsUnsupported` | Priority requests are unsupported at the provided intersection | content: application/json: schema: {$ref: '#/components/schemas/PriorityRequestsUnsupported'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/intersections/{intersectionId}/priorityRequests/{priorityRequestId}: parameters: - {$ref: '#/components/parameters/intersectionId'} - {$ref: '#/components/parameters/priorityRequestId'} delete: summary: End the specified Priority Request at the specified Intersection tags: [Priority Requests] operationId: endPriorityRequestV1 responses: '200': {$ref: '#/components/responses/EndPriorityRequestResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------|-------------------------------------| | `InvalidFilter` | The path parameter provided is invalid.| | `InvalidRequestException` | The provided request is invalid. | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure the intersection and priority request provided exist, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `PriorityRequestNotFound` | Unable to find priority request with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} get: summary: Retrieve the specified Priority Request at the specified intersection description: | This request initiates a round-trip to the controller to retrieve its current status. Normally, this will complete in under 2 seconds. tags: [Priority Requests] operationId: getPriorityRequestV1 responses: '200': {$ref: '#/components/responses/GetPriorityRequestResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------|-------------------------------------| | `InvalidFilter` | The path parameter provided is invalid.| content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure the intersection and priority request provided exist, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `PriorityRequestNotFound` | Unable to find priority request with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} put: summary: Update the Time to Live of the specified Priority Request at the specified Intersection description: | **NOTE**: The only property of a Priority Request that can be changed is the Time to Live. tags: [Priority Requests] operationId: updatePriorityRequestV1 requestBody: {$ref: '#/components/requestBodies/UpdatePriorityRequest'} responses: '200': {$ref: '#/components/responses/UpdatePriorityRequestResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |----------------------------------|-------------------------------------| | `PriorityRequestAlreadyExpired` | Request has already expired. Create a new request instead. | | `InvalidFilter` | The path parameter provided is invalid.| | `ValidationSingleBadArgument` | An argument is invalid. | | `InvalidRequestException` | The provided request is invalid. | content: application/json: schema: {$ref: '#/components/schemas/Error'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure the intersection and priority request provided exist, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `IntersectionNotFound` | Unable to find intersection with id: UUID | | `PriorityRequestNotFound` | Unable to find priority request with id: UUID | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/medianTravelTimes: get: summary: Retrieve TravelTime from a source Intersection to a destination Intersection description: | Returns TravelTime between the specified intersections for a 24-hour period, aggregated into 15 minutes bins. By default, results are aggregated into 1 minute bins. This can be changed by adding a `binSize` parameter (Integer) to the querystring which will change the number of minutes. The unit of time can be changed by adding a `binUnits` parameter (String) to the querystring. Valid bin units include: [`Minute`, `Hour`, `Day`]. By default, the 24-hour period ends at the time the request is submitted. The end of the 24-hour period can be specified with the `endDateTime` parameter. tags: [Median Travel Time] operationId: getMedianTravelTimeV1 parameters: - {$ref: '#/components/parameters/binSize'} - {$ref: '#/components/parameters/binUnits'} - {$ref: '#/components/parameters/destinationIntersectionId'} - {$ref: '#/components/parameters/endDateTime'} - {$ref: '#/components/parameters/sourceIntersectionId'} responses: '200': {$ref: '#/components/responses/TravelTimeResponse'} '400': description: | Bad request, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------------|-----------------------------------------------| | `InvalidEndDateTime` | End time has to be at least 15 minutes old | '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure passing valid filters, see the error description for details.
Error code returned in JSON: | Error code | Description | |-----------------------------|----------------------------------------------------------------------------| | `InvalidMedianHits` | We do not have any overlapping trips recorded for those two intersections. | content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} '500': description: | Internal server error, see the error description for details.
Error code returned in JSON: | Error code | Description | |-------------------|-----------------------------------------------------------------------------------------------------------------------------| | `InternalError` | An internal error occurred when processing this request - please reach out to Miovision Support for more details | content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} /v1/users/userInfo: get: tags: [Users] summary: Retrieve the current user info. description: Returns a user info object containing information for the current user. operationId: getUserInfoV1 responses: '200': {$ref: '#/components/responses/GetUserInfoResponse'} '403': description: | The request was unauthorized. Ensure the correct apikey was provided.
Error code returned in JSON: | Error code | Description | |---------------------------------|---------------------------| | `UnauthorizedResourceException` | Unauthorized for resource | content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} '404': description: | Ensure userId or organizationId exists, see the error description for details.
Error code returned in JSON: | Error code | Description | |------------------------|-------------------------------------------| | `UserIdNotFound` | Unable to find User with id: UUID | | `OrganizationNotFound` | Unable to find Organization with id: UUID | '500': {$ref: '#/components/responses/GeneralException'} components: parameters: binSize: in: query name: binSize description: |- The length of time in which to bin TravelTime data. Defaults to 1. The unit of time is specified by the `binUnits` parameter, which defaults to `Minute`. required: false schema: {$ref: '#/components/schemas/Minutes'} binUnits: in: query name: binUnits description: |- The time unit to use for binning. Defaults to `Minute`. Valid values are [`Minute`, `Hour`, `Day`] required: false schema: {$ref: '#/components/schemas/BinUnitEnum'} cameraId: in: path name: cameraId description: Uniquely identifies one Camera required: true schema: {$ref: '#/components/schemas/Identifier'} crosswalkVehicleClasses: in: query name: vehicleClasses description: | A comma-separated list of vehicle classes to include in the results. Defaults to `Pedestrian,Bicycle`. required: false example: Pedestrian schema: {$ref: '#/components/schemas/CrosswalkVehicleClasses'} destinationIntersectionId: in: query name: destinationIntersectionId description: Uniquely identifies the destination Intersection. required: true schema: {$ref: '#/components/schemas/Identifier'} endDateTime: in: query name: endDateTime description: | The latest DateTime for the query. Must be at least 15 minutes before now. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: true schema: {$ref: '#/components/schemas/DateTime'} endDateTimeHiRes: in: query name: endDateTime description: | The latest DateTime for the query. Defaults to 15 minutes after start time, or now if no start time is provided. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} endDateTimeAlerts: in: query name: endDateTime description: | The end date and time for the alerts query. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} endDateTimePriority: in: query name: endDateTime description: | The latest date and time for the Priority Requests query. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} intersectionId: name: intersectionId description: Uniquely identifies one Intersection. in: path required: true schema: {$ref: '#/components/schemas/Identifier'} isOpen: name: isOpen description: Filters the Priority Request results to those that are currently open. in: query required: false schema: {$ref: '#/components/schemas/IsOpen'} organizationId: name: organizationId description: Uniquely identifies one Organization. in: path required: true schema: {$ref: '#/components/schemas/Identifier'} pageNumber: in: query name: pageNumber description: Number of pages to be displayed. Note that pages are 0-indexed. required: false schema: {$ref: '#/components/schemas/PageNumber'} pageSize: in: query name: pageSize description: Number of items to be displayed on page. required: false schema: {$ref: '#/components/schemas/PageSize'} pageSizeWithMax: in: query name: pageSize description: Number of items to be displayed on page. Maximum value is 1000. required: false schema: {$ref: '#/components/schemas/PageSizeWithMax'} timingPlanPageSize: in: query name: pageSize description: Number of items to be displayed on page. Defaults to 25. Maximum value is 100. required: false schema: {$ref: '#/components/schemas/TimingPlanPageSize'} timingPlanSort: in: query name: sort description: 'Sort direction for the createdOn field. Supported values (case sensitive): ''ASC'', ''DESC''. If omitted, defaults to ''DESC''.' required: false schema: {$ref: '#/components/schemas/TimingPlanSort'} priorityRequestId: in: path name: priorityRequestId description: Uniquely identifies the Priority Request. required: true schema: {$ref: '#/components/schemas/Identifier'} sourceIntersectionId: in: query name: sourceIntersectionId description: Uniquely identifies the source Intersection. required: true schema: {$ref: '#/components/schemas/Identifier'} startDateTime: in: query name: startDateTime description: | The start date and time for the query. Defaults to 15 minutes before `endDateTime`. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} startDateTimeHiRes: in: query name: startDateTime description: | The start DateTime for the query. Defaults to 15 minutes before `endDateTime`, or 15 minutes before now if no end time is provided. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} startDateTimeAlerts: in: query name: startDateTime description: | The start date and time for the alerts query. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} startDateTimePriority: in: query name: startDateTime description: | The earliest date and time for the Priority Requests query. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. required: false schema: {$ref: '#/components/schemas/DateTime'} vehicleClasses: in: query name: vehicleClasses description: An array of vehicle classes to include in the results. Defaults to all classes. example: Light,ArticulatedTruck required: false schema: {$ref: '#/components/schemas/VehicleClasses'} severityLevels: in: query name: severityLevels description: Filter conflicts by severity level (comma-separated values), see ConflictSeverityEnum below for all the options required: false schema: {type: string, example: 'Critical,High'} roadUserTypesLeading: in: query name: roadUserTypesLeading description: Filter conflicts by leading road user type (comma-separated values), see ConflictRoadUserEnum below for all the options required: false schema: {type: string, example: 'Vehicle,Pedestrian'} roadUserTypesLagging: in: query name: roadUserTypesLagging description: Filter conflicts by lagging road user type (comma-separated values), see ConflictRoadUserEnum below for all the options required: false schema: {type: string, example: 'Vehicle,Pedestrian'} configurations: in: query name: configurations description: Filter conflicts by configuration type (comma-separated values), see ConflictConfigurationEnum below for all the options required: false schema: {type: string, example: 'SouthLeftHook,NorthLeftHook'} includeShared: in: query name: includeShared description: If true, includes intersections shared with the organization. Defaults to false. required: false schema: {type: boolean, default: false} requestBodies: AddFileRequest: description: Upload an Intersection File content: image/jpeg: schema: {$ref: '#/components/schemas/Image'} image/png: schema: {$ref: '#/components/schemas/Image'} CreatePriorityRequest: description: Create a Priority Request required: true content: application/json: schema: {$ref: '#/components/schemas/PriorityRequest'} UpsertNotesRequest: description: Create or Update an Intersection Note required: true content: application/json: schema: {$ref: '#/components/schemas/Note'} UpdatePriorityRequest: description: | The new Time to Live value for the Priority Request required: true content: application/json: schema: {$ref: '#/components/schemas/UpdatePriorityRequest'} responses: GeneralException: description: An unexpected error has occurred. content: application/json: schema: {$ref: '#/components/schemas/GeneralException'} InvalidInputException: description: One or more parameter values is invalid. content: application/json: schema: {$ref: '#/components/schemas/Error'} ResourceNotFoundException: description: No resource with the specified ID exists. content: application/json: schema: {$ref: '#/components/schemas/ResourceNotFound'} UnauthorizedResourceException: description: The provided access token does not have the scope required to access the requested resource. content: application/json: schema: {$ref: '#/components/schemas/UnauthorizedResource'} AddFileResponse: {description: The File was added.} CreatePriorityRequestResponse: description: The Priority Request was created. content: application/json: schema: {$ref: '#/components/schemas/PriorityRequestView'} EndPriorityRequestResponse: {description: The Priority Request was ended.} GetAlertsResponse: description: Paged list of active Alerts. content: application/json: schema: {$ref: '#/components/schemas/AlertsPageView'} GetCameraSnapshotResponse: description: A Snapshot from the specified Camera. content: image/jpeg: schema: {$ref: '#/components/schemas/Image'} GetCamerasResponse: description: Paged list of available camera sources. content: application/json: schema: {$ref: '#/components/schemas/CameraPageView'} GetCommunicationDeviceDiagnosticsResponse: description: Diagnostic for a communication device. content: application/json: schema: {$ref: '#/components/schemas/DiagnosticsView'} GetCrosswalkTmcResponse: description: Crosswalk TMC results. content: application/json: schema: items: {$ref: '#/components/schemas/CrosswalkTmc'} GetDetectionDeviceDiagnosticsResponse: description: Diagnostic for a detection device. content: application/json: schema: {$ref: '#/components/schemas/DiagnosticsView'} GetHiResDataResponse: description: High Resolution Data Logger output for an Intersection. content: application/json: schema: type: array items: {$ref: '#/components/schemas/HiResDataLogEvent'} GetIntersectionNotesResponse: description: Notes regarding an Intersection. content: application/json: schema: {$ref: '#/components/schemas/Note'} GetIntersectionResponse: description: Details of an Intersection. content: application/json: schema: {$ref: '#/components/schemas/Intersection'} GetIntersectionsResponse: description: Paged list of Intersections. content: application/json: schema: {$ref: '#/components/schemas/IntersectionsPageView'} GetIntersectionsHardwareResponse: description: Paged list of Intersections' hardware. content: application/json: schema: {$ref: '#/components/schemas/IntersectionsHardwarePageView'} GetIntersectionsHardwareConfigurationsResponse: description: Hardware configuration details. content: application/json: schema: {$ref: '#/components/schemas/IntersectionHardwareConfigurationView'} GetIntersectionSimpleDelayResponse: description: Simple Delay details content: application/json: schema: {$ref: '#/components/schemas/IntersectionSimpleDelayBins'} GetIntersectionRedLightRunnersResponse: description: Red Light Runners details content: application/json: schema: {$ref: '#/components/schemas/IntersectionRedLightRunnerBins'} GetIntersectionPedComplianceResponse: description: Ped Compliance crossing details content: application/json: schema: {$ref: '#/components/schemas/IntersectionPedComplianceBins'} GetIntersectionConflictsResponse: description: Conflict/near miss events for an intersection content: application/json: schema: {$ref: '#/components/schemas/ConflictEventsPageView'} GetIntersectionTmcCsvResponse: description: Intersection TMC results in CSV format. content: text/csv: schema: {type: string} GetIntersectionTmcLanesResponse: description: The Intersection TMC Lane results. content: application/json: schema: type: array items: {$ref: '#/components/schemas/TmcLane'} GetIntersectionTmcResponse: description: The TMC results. content: application/json: schema: items: {$ref: '#/components/schemas/TmcResult'} GetOrganizationResponse: description: Details of one Organization. content: application/json: schema: {$ref: '#/components/schemas/Organization'} GetPriorityCapabilitiesResponse: description: Priority Request related capabilities of an Intersection content: application/json: schema: {$ref: '#/components/schemas/PriorityCapabilities'} GetPriorityRequestResponse: description: A Priority Request content: application/json: schema: {$ref: '#/components/schemas/PriorityRequestView'} GetPriorityRequestsResponse: description: Paged list of Priority Requests content: application/json: schema: {$ref: '#/components/schemas/PriorityRequestsPageView'} GetUserInfoResponse: description: User info for the current user. content: application/json: schema: {$ref: '#/components/schemas/UserInfo'} PutIntersectionNotesResponse: description: Notes for a given intersection. content: application/json: schema: {$ref: '#/components/schemas/Note'} TravelTimeResponse: description: The Travel Time between two specified Intersections. The median is the Travel Time in seconds. content: application/json: schema: {$ref: '#/components/schemas/TravelTime'} UpdatePriorityRequestResponse: description: The Priority Request has been updated. content: application/json: schema: {$ref: '#/components/schemas/PriorityRequestStatusView'} securitySchemes: ApiKeyAuth: {type: apiKey, in: header, name: apikey} schemas: Alert: type: object properties: alertId: {type: string, description: A unique identifier for the Alert.} alertStartDateTime: {type: string, nullable: true, format: date-time, description: 'The date and time when the Alert starts, in ISO 8601 format.'} alertEndDateTime: {type: string, nullable: true, format: date-time, description: 'The date and time when the Alert ends, in ISO 8601 format.'} intersectionId: {type: string, description: Uniquely identifies the Intersection at which the Alert occurred.} type: {type: string, description: The type of Alert being issued. This is a machine readable string.} AlertsPageView: type: object properties: alerts: type: array description: One page of Alerts items: {$ref: '#/components/schemas/Alert'} links: {$ref: '#/components/schemas/Links'} BinUnitEnum: example: Minute type: string enum: [Minute, Hour, Day] CrosswalkTmc: type: object properties: timestamp: allOf: - {$ref: '#/components/schemas/DateTime'} description: | The minute in time included in this bucket. On the **v2** endpoint this is in the Organization's local timezone (e.g. `…-05:00`); on the deprecated **v1** endpoint it is in UTC (`Z`). Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format class: allOf: - {$ref: '#/components/schemas/CrosswalkVehicleClassEnum'} description: The classification of this bucket. Either `Pedestrian` or `Bicycle`. crosswalkSide: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: The side of the Intersection at which the pedestrians crossed. direction: {type: string, description: 'Which way the pedestrians travelled through the crosswalk. Either `CW` (clockwise), or `CCW` (counter-clockwise).'} qty: allOf: - {$ref: '#/components/schemas/Quantity'} description: The number of pedestrians in the bucket. Camera: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Camera Source type: {type: string, description: The type of the Camera peripheral.} label: {type: string, description: The name of the Camera peripheral.} streamUrl: {type: string, description: The url of the Camera stream.} CameraPageView: type: object properties: cameras: type: array description: A page of cameras. items: {$ref: '#/components/schemas/Camera'} links: {$ref: '#/components/schemas/Links'} ConflictEventsPageView: type: object properties: conflictEvents: type: array description: One page of conflict events items: {$ref: '#/components/schemas/ConflictEvent'} links: {$ref: '#/components/schemas/Links'} ConflictEvent: type: object properties: id: {type: string, description: Unique identifier for the conflict event, example: abc123} indicatorType: type: string description: Type of conflict indicator enum: [PET] example: PET indicatorValue: {type: number, format: float, description: Numeric value of the conflict indicator, example: 1.5} datetimeLocal: type: string format: date-time description: | Date and time when the conflict happened. On the **v2** endpoint this is in the Organization's local timezone (e.g. `…-05:00`); on the deprecated **v1** endpoint it is in UTC (`Z`). example: 2017-08-30T18:32:00Z configuration: {$ref: '#/components/schemas/ConflictConfigurationEnum'} severityLevel: {$ref: '#/components/schemas/ConflictSeverityEnum'} conflictSpeed: {type: number, format: float, description: Speed at point of conflict in m/s, example: 8.5} leadingRoadUser: {$ref: '#/components/schemas/RoadUser'} laggingRoadUser: {$ref: '#/components/schemas/RoadUser'} RoadUser: type: object properties: roadUserType: {$ref: '#/components/schemas/ConflictRoadUserEnum'} speed: {type: number, format: float, description: Speed of the road user in m/s, example: 5.2} Connectivity: type: object properties: connected: {type: boolean} timestamp: {type: integer, format: int64} disconnectReason: {type: string} CrosswalkMovementEnum: example: CW type: string enum: [CW, CCW] description: Represents either clockwise or counter-clockwise direction the pedestrian traveled CrosswalkVehicleClassEnum: example: Pedestrian type: string enum: [Pedestrian, Bicycle] CrosswalkVehicleClasses: type: array items: {$ref: '#/components/schemas/CrosswalkVehicleClassEnum'} ConflictConfigurationEnum: description: Safety conflict configuration based on road user type and movements example: [NorthLeftHook] enum: [NorthLeftHook, SouthLeftHook, EastLeftHook, WestLeftHook, NorthRightHook, SouthRightHook, EastRightHook, WestRightHook, NorthThruFarSide, SouthThruFarSide, EastThruFarSide, WestThruFarSide, NorthTLRNearSide, SouthTLRNearSide, EastTLRNearSide, WestTLRNearSide, Unconventional, WestLeftVsEastThru, WestLeftVsNorthThru, EastLeftVsSouthThru, EastLeftVsWestThru, SouthLeftVsWestThru, SouthLeftVsNorthThru, NorthLeftVsSouthThru, NorthLeftVsEastThru, SouthThruVsWestThru, SouthThruVsEastThru, NorthThruVsEastThru, NorthThruVsWestThru, WestThruVsSouthThru, WestThruVsNorthThru, EastThruVsNorthThru, EastThruVsSouthThru] ConflictRoadUserEnum: description: Safety road user classification mappings example: [Vehicle, Pedestrian] type: string enum: [Pedestrian, Cyclist, Motorcyclist, Vehicle] ConflictSeverityEnum: description: Conflict severity based on road user types, speed and configuration example: [High] type: string enum: [Critical, High, Medium, Low] CvClassificationEnum: description: All CV classification mappings example: [Car, Pedestrian] type: string enum: [ArticulatedTruck, Bicycle, Bus, Car, Motorcycle, MotorizedVehicle, NonMotorizedVehicle, Pedestrian, PickupTruck, SingleUnitTruck, WorkVan, Unknown] DateTime: {example: !!timestamp '2018-03-25T14:12:00Z', type: string, format: date-time} DetectionDevice: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Detection Device serial: {type: string} label: {type: string} connectivity: {$ref: '#/components/schemas/Connectivity'} Device: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Device serial: {type: string} label: {type: string} connectivity: {$ref: '#/components/schemas/Connectivity'} DiagnosticsView: type: object additionalProperties: {$ref: '#/components/schemas/DiagnosticStatus'} DiagnosticStatus: type: object properties: name: {type: string} state: type: string enum: [pending, success, failed, warning, unknown, n/a] description: {type: string} DirectionEnum: type: string enum: [N, S, E, W, NE, SE, SW, NW, UNDEFINED] EncodedIntersectionHardwareConfigurations: type: string description: | Base64-encoded string containing json representation of historical configurations. **Note:** The format of the json representation is used internally by Miovision and is subject to change at any time without notice. Error: description: Custom error returned when an exception is thrown. properties: code: {type: string, description: An error code., example: Value from ErrorCodes.kt} message: {type: string, description: A description of the error., example: More information about the error.} details: type: array description: Used to provide details when multiple errors are rolled up in a given response. items: {$ref: '#/components/schemas/Error'} innererror: description: Optional additional information about the cause of this error. allOf: - {$ref: '#/components/schemas/InnerError'} FineTuning: type: object properties: kind: {type: string} hyperSensitivityMode: {$ref: '#/components/schemas/HypersensitivityMode'} HypersensitivityMode: type: object properties: forgetTimeSeconds: {type: number, format: double} GeneralException: allOf: - {$ref: '#/components/schemas/SingleError'} properties: code: {example: NullPointerException} message: {example: An unspecified error has occurred.} Hash: {type: string, description: A hash value to validate the contents of configurations} HiResDataLogEvent: type: object properties: timestamp: {$ref: '#/components/schemas/MsSinceEpoch'} eventCode: {$ref: '#/components/schemas/HiResEventCode'} eventParam: {$ref: '#/components/schemas/HiResEventParameter'} HiResEventCode: type: integer example: 10 description: | Valid values: * 0 (Phase On) * 1 (Phase Begin Green) * 7 (Phase Green Termination) * 8 (Phase Begin Yellow Clearance) * 9 (Phase End Yellow Clearance) * 10 (Phase Begin Red Clearance) * 11 (Phase End Red Clearance) * 12 (Phase Inactive) * 21 (Pedestrian Begin Walk) * 22 (Pedestrian Begin Clearance) * 23 (Pedestrian Begin Solid Don't Walk) * 61 (Overlap Begin Green) * 63 (Overlap Begin Yellow) * 64 (Overlap Begin Red Clearance) * 65 (Overlap Off) * 81 (Detector Off) * 82 (Detector On) * 89 (PedDetector Off) * 90 (PedDetector On) HiResEventParameter: {type: integer, description: The event parameter from the high resolution data logger specification., example: 2} Identifier: {example: 30e40c11-cfa4-48aa-9ac7-b50d5c29db8d, type: string, format: uuid} Image: {type: string, format: binary} InnerError: properties: code: {type: string, description: An error code.} innererror: description: Optional additional information about the cause of this error. allOf: - {$ref: '#/components/schemas/InnerError'} Intersection: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Intersection. lat: {description: The latitude of this intersection., type: number, format: double} long: {description: The longitude of this intersection., type: number, format: double} name: {type: string} customId: {type: string} IntersectionHardware: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Intersection. devices: type: array items: {$ref: '#/components/schemas/Device'} detectionDevices: type: array items: {$ref: '#/components/schemas/DetectionDevice'} peripherals: type: array items: {$ref: '#/components/schemas/Peripheral'} IntersectionHardwareConfigurationView: type: object properties: lastUpdated: {$ref: '#/components/schemas/MsSinceEpoch'} hash: {$ref: '#/components/schemas/Hash'} configurations: {$ref: '#/components/schemas/EncodedIntersectionHardwareConfigurations'} IntersectionsHardwarePageView: type: object properties: intersections: type: array description: A page of Intersections' hardware. items: {$ref: '#/components/schemas/IntersectionHardware'} links: {$ref: '#/components/schemas/Links'} IntersectionsPageView: type: object properties: intersections: type: array description: A page of Intersections. items: {$ref: '#/components/schemas/Intersection'} links: {$ref: '#/components/schemas/Links'} IntersectionSimpleDelayBins: type: array items: {$ref: '#/components/schemas/IntersectionSimpleDelayBin'} IntersectionSimpleDelayBin: type: object properties: binStartDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the start of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. binEndDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the end of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. streetName: {type: string, description: Name of the street the intersection is located on or at.} direction: {type: string, description: Acronym for cardinal direction plus suffix -bound., example: EB} medianDelay: {type: number, format: double, description: Median delay for vehicles at the intersection., example: 10.2, minimum: 0} averageDelay: {type: number, format: double, description: Average delay for vehicles at the intersection. 10th place, example: 10.2, minimum: 0} movement: type: string description: Vehicle movement through the intersection. enum: [RT, THRU, LTProtected, LTProtectedAndPermissive] IntersectionRedLightRunnerBins: type: array items: {$ref: '#/components/schemas/IntersectionRedLightRunnerBin'} IntersectionPedComplianceBins: type: array items: {$ref: '#/components/schemas/IntersectionPedComplianceBin'} IntersectionRedLightRunnerBin: type: object properties: binStartDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the start of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. binEndDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the end of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. direction: {type: string, description: Acronym for cardinal direction plus suffix -bound., example: EB} trackMovement: type: string description: Vehicle's general movement through the intersection. enum: [HARD-RIGHT, RT, BEAR-RIGHT, THRU, BEAR-LEFT, LT, HARD-LEFT, U-TURN] x-enum-varnames: [HARD_RIGHT, RT, BEAR_RIGHT, THRU, BEAR_LEFT, LT, HARD_LEFT, U_TURN] phaseMovement: type: string description: Vehicle phase-specific movement through the intersection, with permissive left information if applicable. enum: [RT, THRU, LTProtected, LTProtectedAndPermissive] classification: {$ref: '#/components/schemas/CvClassificationEnum'} yellowLightRunners: {type: integer, description: Total count of vehicles running yellow lights, example: 10, minimum: 0} redLightRunners: {type: integer, description: Total count of vehicles running red lights, example: 5, minimum: 0} IntersectionPedComplianceBin: type: object properties: binStartDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the start of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format binEndDateTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The timestamp for the end of each bin. Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format direction: {$ref: '#/components/schemas/CrosswalkMovementEnum'} crosswalkApproach: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: the cardinal position of the crosswalk's approach in the intersection classification: {$ref: '#/components/schemas/CvClassificationEnum'} yellowLightRunners: {type: integer, description: Total count of pedestrians who crossed during flashing-don't-walk, example: 10, minimum: 0} redLightRunners: {type: integer, description: Total count of pedestrians who crossed during don't-walk, example: 5, minimum: 0} Links: type: object description: URL of the next page of results, if one exists. properties: next: {type: string} Minutes: {type: integer, example: 5, minimum: 0, maximum: 1440} MsSinceEpoch: {type: integer, format: int64, description: The number of milliseconds since the Unix Epoch (1 January 1970), example: 1700492731} Note: type: object properties: content: {type: string} OneToTen: {description: A priority scale from 1 (highest) to 10 (lowest), type: integer, minimum: 1, maximum: 10} IsOpen: {type: boolean, default: false} Organization: type: object properties: id: allOf: - {$ref: '#/components/schemas/Identifier'} description: Uniquely identifies one Organization. name: {example: MioTown, description: The name of the Organization., type: string} PageNumber: {type: integer, format: int32, minimum: 0, example: 0, default: 0} PageSize: {type: integer, format: int32, minimum: 1, default: 100, example: 101} PageSizeWithMax: {type: integer, format: int32, minimum: 1, maximum: 1000, default: 100, example: 101} TimingPlanPageSize: {type: integer, format: int32, minimum: 1, maximum: 100, default: 25, example: 25} TimingPlanSort: type: string enum: [ASC, DESC] default: DESC example: DESC Peripheral: type: object properties: name: {type: string} type: {type: string} PreemptionData: type: object properties: preemptNumber: {description: 'The preempt number to actuate, either using NTCIP or physical inputs.', type: integer, minimum: 0} PriorityCapabilities: type: object properties: outputMode: {type: string} prioritySupported: {type: boolean} PriorityData: type: object properties: requestId: {description: NTCIP 1211 priority request identifier, type: integer} vehicleId: {description: 'ID of the vehicle, max length 16', type: string, maxLength: 16} vehicleClass: allOf: - {$ref: '#/components/schemas/OneToTen'} description: The classification of a vehicle, on a scale from 1 (highest) to 10 (lowest) vehicleClassLevel: allOf: - {$ref: '#/components/schemas/OneToTen'} description: | The priority of a vehicle, within the classification of vehicles, on a scale from 1 (highest) to 10 (lowest) serviceStrategy: {description: NTCIP 1211 requested service strategy for this request., type: integer} PriorityRequest: type: object properties: id: {description: Uniquely identifies one Priority Request., type: string} timeToLive: {$ref: '#/components/schemas/TimeToLive'} msgId: {description: Client-specific identifier. Will be logged along with other information for future correlation., type: string} obuId: description: | Client-specific identifier for the vehicle which triggered this request. Can be used for reporting and to determine the "track" of a vehicle. type: string tripId: description: | Client-specific identifier for this vehicle's trip. Can be used for reporting and to determine the "track" of a particular call-out. type: string type: {$ref: '#/components/schemas/PriorityRequestTypeEnum'} preemptionData: allOf: - {$ref: '#/components/schemas/PreemptionData'} description: | If this is a preemption request (see type), this sub-object will be defined and contain details on the preemption-specific parts of this request. Only one of preemptionData and priorityData will be non-null. priorityData: allOf: - {$ref: '#/components/schemas/PriorityData'} description: | If this is a priority request (see type), this sub-object will be defined and contain details on the priority-specific parts of this request. Only one of preemptionData and priorityData will be non-null. required: false required: [timeToLive, type] PriorityRequestView: allOf: - {$ref: '#/components/schemas/PriorityRequest'} properties: startedTimestamp: {description: The moment in time the request was received by Miovision. Epoch milliseconds., type: number} lastUpdatedTimestamp: {description: The last update time for this preempt (set by a PATCH request), type: number} ttlRemaining: {description: The remaining time-to-live of this preempt., type: integer} endedTimestamp: {description: The moment in time the request was cancelled or timed out. Epoch milliseconds., type: number} status: description: | What happened with this request. Available options: failed - Request was received by Miovision, but failed to route to the controller. in_progress - Request received by controller, and is currently timing. ended_ttl - Request ended due to an expired TTL. ended_cleared - Request ended due to being cleared through the API. type: string error: {$ref: '#/components/schemas/PriorityServiceError'} RequestStatus1211Enum: description: The type of request status. Indicates the status of the returned request status type: string enum: [idleNotValid, readyQueued, readyOverridden, activeProcessing, activeCancel, activeOverride, activeNotOverridden, closedCanceled, reserviceError, closedTimeToLiveError, closedTimerError, closedStrategyError, closedCompleted, activeAdjustNotNeeded, closedFlash, unknown] PriorityRequestStatusView: description: The priority request status view, as an example {"requestStatus1211":"activeProcessing"} properties: requestStatus1211: {$ref: '#/components/schemas/RequestStatus1211Enum'} PriorityRequestTypeEnum: description: The type of a Priority Request. Indicates whether preemptionData or priorityData is present. type: string enum: [priority, preemption] PriorityRequestsPageView: type: object properties: priorityRequests: type: array description: One page of Priority Requests items: {$ref: '#/components/schemas/PriorityRequest'} links: {$ref: '#/components/schemas/Links'} PriorityServiceError: description: | A generic error class. The intention is to be able to copy-paste this to Miovision support and provide enough context to help triage issues. type: object properties: message: type: string description: | Human-readable error representation. Begins with an error code like: `UNKNOWN` - Something unexpected happened. Message/target may contain more details. `INVALID_REQUEST` - The request contained invalid data (see message/target fields) `UNSUPPORTED` - The request type is unsupported (i.e. priority request to an intersection with no priority capabilities) `COMMS_FAILURE` - The controller was unreachable or responded incorrectly. `BAD_AUTH` - Authentication provided was invalid. then a human-readable string describing the error and a target. timestamp: {description: epoch-milliseconds timestamp of when the error was generated, type: integer} error: {description: Text-description of the HTTP status code returned., type: string} status: {description: The returned HTTP status, type: integer} path: {description: Internal path of the service serving the request., type: string} Quantity: {description: The number of vehicles in the bucket., type: integer, example: 12} PriorityRequestsUnsupported: allOf: - {$ref: '#/components/schemas/SingleError'} properties: message: {example: Priority requests are unsupported at the provided intersection. Use the capabilities endpoint to check if priority requests are supported.} code: {example: PriorityRequestsUnsupported} ResourceNotFound: allOf: - {$ref: '#/components/schemas/SingleError'} properties: message: {example: Unable to find Resource with id 05d20146-89b8-455c-8580-9b24abf07994.} code: {example: ResourceNotFoundException} SingleError: allOf: - {$ref: '#/components/schemas/Error'} properties: details: {example: null} innererror: {example: null} fineTuning: {$ref: '#/components/schemas/FineTuning'} TmcLane: type: object properties: timestamp: allOf: - {$ref: '#/components/schemas/DateTime'} description: | The minute in time included in this bucket. On the **v2** endpoint this is in the Organization's local timezone (e.g. `…-05:00`); on the deprecated **v1** endpoint it is in UTC (`Z`). Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format class: allOf: - {$ref: '#/components/schemas/VehicleClassGroupEnum'} description: The grouped classification of vehicles in the bucket. entrance: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: The Approach from which the vehicles started. exit: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: The Approach through which the vehicles exited. laneId: {type: string, description: Identifies the Lane in which the vehicles started.} qty: allOf: - {$ref: '#/components/schemas/Quantity'} TmcResult: type: object properties: timestamp: allOf: - {$ref: '#/components/schemas/DateTime'} description: | The minute in time included in this bucket. On the **v2** endpoint this is in the Organization's local timezone (e.g. `…-05:00`); on the deprecated **v1** endpoint it is in UTC (`Z`). Expressed in [ISO-8601](https://www.iso.org/iso-8601-date-and-time-format.html) format class: allOf: - {$ref: '#/components/schemas/VehicleClassGroupEnum'} description: The grouped classification of vehicles in the bucket. entrance: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: The Approach from which the vehicles started. exit: allOf: - {$ref: '#/components/schemas/DirectionEnum'} description: The approach through which the vehicles left. qty: allOf: - {$ref: '#/components/schemas/Quantity'} TravelTime: type: object properties: travelTime: type: array items: type: object properties: startTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The start time of the 15 minute bin. endTime: allOf: - {$ref: '#/components/schemas/DateTime'} description: The end time of the 15 minute bin. median: {description: The travel time in seconds., type: number} dataConfidence: example: HIGH type: string description: | Miovision's confidence in the returned data. Based on the number of non-outlier data points we had for our computation. Either 'HIGH' or 'LOW'. TimeToLive: {description: Seconds after receipt of request or update that the request should be kept alive. (1 - 180), default: 180, type: integer, minimum: 1, maximum: 180} UnauthorizedResource: allOf: - {$ref: '#/components/schemas/SingleError'} properties: message: {example: Access token does not have the required scope.} code: {example: UnauthorizedResourceException} UpdatePriorityRequest: type: object properties: timeToLive: {$ref: '#/components/schemas/TimeToLive'} UserInfo: type: object properties: externalUserId: {example: user@example.com, type: string, description: Uniquely identifies the user in a non-Miovision system. Typically email address.} organizationName: {example: MioTown, type: string, description: The name of the Organization in which the User is currently active.} VehicleClassEnum: example: SingleUnitTruck type: string enum: [Pedestrian, Bicycle, Car, Motorcycle, PickupTruck, WorkVan, Bus, SingleUnitTruck, ArticulatedTruck, MotorizedVehicle] VehicleClassGroupEnum: example: Light type: string enum: [Pedestrian, Bicycle, Light, Bus, SingleUnitTruck, ArticulatedTruck, MotorizedVehicle] VehicleClasses: type: array items: {$ref: '#/components/schemas/VehicleClassEnum'} VehicleClassGroups: type: array items: {$ref: '#/components/schemas/VehicleClassGroupEnum'} TimingPlan: type: object description: A timing plan revision for a traffic signal controller required: [id, organizationId, intersectionId, isDraft, createdOn] properties: id: {type: string, description: Unique identifier for this timing plan revision} organizationId: {type: string, format: uuid, description: Organization that owns this timing plan} intersectionId: {type: string, format: uuid, description: Intersection this timing plan belongs to} isDraft: {type: boolean, description: Whether this timing plan is a draft} createdOn: {type: string, format: date-time, description: When this revision was created} createdBy: {type: string, description: User who created this revision} timingPlan: {$ref: '#/components/schemas/TimingPlanData'} TimingPlanSummary: type: object description: Summary metadata for a deployed timing plan revision. required: [id, organizationId, intersectionId, createdOn] properties: id: {type: string, description: Unique identifier for this timing plan revision} organizationId: {type: string, format: uuid, description: Organization that owns this timing plan} intersectionId: {type: string, format: uuid, description: Intersection this timing plan belongs to} createdOn: {type: string, format: date-time, description: When this revision was created} createdBy: {type: string, description: User who created this revision} notes: {type: string, description: Notes associated with this timing plan revision} TimingPlanLinks: type: object description: URLs for adjacent pages of timing plan results, if they exist. properties: next: {type: string} prev: {type: string} TimingPlansPageView: type: object properties: timingPlans: type: array description: One page of timing plan revision summaries. items: {$ref: '#/components/schemas/TimingPlanSummary'} links: {$ref: '#/components/schemas/TimingPlanLinks'} totalPages: {type: integer, format: int32, minimum: 0, example: 0} totalElements: {type: integer, format: int64, minimum: 0, example: 0} TimingPlanData: type: object description: The actual timing plan configuration data properties: schedules: type: array items: {$ref: '#/components/schemas/Schedule'} dayPlans: type: array items: {$ref: '#/components/schemas/DayPlan'} actions: type: array items: {$ref: '#/components/schemas/Action'} patterns: type: array items: {$ref: '#/components/schemas/TimingPattern'} splits: type: array items: {$ref: '#/components/schemas/Split'} sequences: type: array items: {$ref: '#/components/schemas/Sequence'} phases: type: array items: {$ref: '#/components/schemas/Phase'} channels: type: array items: {$ref: '#/components/schemas/Channel'} vehicleDetectors: type: array items: {$ref: '#/components/schemas/VehicleDetector'} pedDetectors: type: array items: {$ref: '#/components/schemas/PedDetector'} preempts: type: array items: {$ref: '#/components/schemas/Preempt'} overlaps: type: array items: {$ref: '#/components/schemas/Overlap'} globalSetIdParameter: {type: integer} controllerDetails: {$ref: '#/components/schemas/ControllerDetails'} coordinationParameters: {$ref: '#/components/schemas/CoordinationParameters'} splitsLikelyPercent: {type: boolean} Schedule: type: object description: Schedule configuration for timing plan activation properties: number: {type: integer} months: type: array items: {type: integer} days: type: array items: {type: integer} dates: type: array items: {type: integer} dayPlan: {type: integer} delete: {type: boolean} DayPlan: type: object description: Day plan configuration properties: number: {type: integer} events: type: array items: {$ref: '#/components/schemas/DayPlanEvent'} delete: {type: boolean} DayPlanEvent: type: object description: Event within a day plan properties: number: {type: integer} hour: {type: integer} minute: {type: integer} actionNumber: {type: integer} delete: {type: boolean} Action: type: object description: Timing plan action configuration properties: number: {type: integer} auxiliaryFunctions: type: array items: {type: integer} specialFunctions: type: array items: {type: integer} pattern: {type: integer} delete: {type: boolean} TimingPattern: type: object description: Pattern configuration for signal timing properties: number: {type: integer} cycleTime: {type: integer} offsetTime: {type: integer} splitNumber: {type: integer} sequenceNumber: {type: integer} coordinationSyncPoint: {type: integer} delete: {type: boolean} Split: type: object description: Split timing configuration properties: number: {type: integer} phases: type: array items: {$ref: '#/components/schemas/SplitPhase'} delete: {type: boolean} SplitPhase: type: object description: Phase timing within a split properties: number: {type: integer} time: {type: integer} mode: {type: integer} coordinated: {type: boolean} referencePoint: {type: boolean} delete: {type: boolean} Sequence: type: object description: Phase sequence configuration properties: number: {type: integer} rings: type: array items: {$ref: '#/components/schemas/SequenceRing'} SequenceRing: type: object description: Ring configuration within a sequence properties: number: {type: integer} phases: type: array items: {type: integer} Phase: type: object description: Signal phase configuration properties: number: {type: integer} walk: {type: number} pedestrianClear: {type: number} minimumGreen: {type: number} passage: {type: number} yellowChange: {type: number} redClear: {type: number} redRevert: {type: number} addedInitial: {type: number} maximumInitial: {type: number} timeBeforeReduction: {type: number} carsBeforeReduction: {type: integer} timeToReduce: {type: number} reduceBy: {type: number} minimumGap: {type: number} dynamicMaxLimit: {type: number} dynamicMaxStep: {type: number} startup: {type: integer} ring: {type: integer} options: type: array items: {type: string} concurrency: type: array items: {type: integer} pedestrianAdvanceWalkTime: {type: number} pedestrianDelayWalkTime: {type: number} Channel: type: object description: Output channel configuration properties: number: {type: integer} controlSource: {type: integer} controlType: {type: integer} flash: type: array items: {type: boolean} VehicleDetector: type: object description: Vehicle detector configuration properties: number: {type: integer} callPhase: {type: integer} switchPhase: {type: integer} delay: {type: number} extend: {type: number} failTime: {type: integer} maxPresence: {type: integer} noActivity: {type: integer} erraticCounts: {type: integer} queueLimit: {type: integer} options: type: array items: {type: string} travelMode: {type: integer} reportedAlarms: type: array items: {type: string} pairedDetector: {type: integer} avgVehicleLength: {type: number} length: {type: number} PedDetector: type: object description: Pedestrian detector configuration properties: number: {type: integer} callPhase: {type: integer} maxPresence: {type: integer} noActivity: {type: integer} erraticCounts: {type: integer} Preempt: type: object description: Preempt configuration for emergency vehicles properties: number: {type: integer} link: {type: integer} delay: {type: number} minimumDuration: {type: number} minimumGreen: {type: number} minimumWalk: {type: number} enterPedClear: {type: number} trackGreen: {type: number} dwellGreen: {type: number} maximumPresence: {type: number} trackPhase: type: array items: {type: integer} dwellPhase: type: array items: {type: integer} dwellPed: type: array items: {type: integer} exitPhase: type: array items: {type: integer} state: {type: integer} trackOverlap: type: array items: {type: integer} dwellOverlap: type: array items: {type: integer} cyclingPhase: type: array items: {type: integer} cyclingPed: type: array items: {type: integer} cyclingOverlap: type: array items: {type: integer} enterYellowChange: {type: number} enterRedClear: {type: number} trackYellowChange: {type: number} trackRedClear: {type: number} control: type: array items: {type: integer} sequenceNumber: {type: integer} exitType: {type: integer} Overlap: type: object description: Overlap phase configuration properties: number: {type: integer} type: {type: integer} includedPhases: type: array items: {type: integer} modifierPhases: type: array items: {type: integer} trailGreen: {type: number} trailYellow: {type: number} trailRed: {type: number} overlapWalk: {type: number} overlapPedClearance: {type: number} ControllerDetails: type: object description: Controller-specific details and limits properties: patternTableType: {type: integer} maximums: {$ref: '#/components/schemas/ControllerDetailsMaximums'} ControllerDetailsMaximums: type: object description: Maximum values for controller configuration properties: phases: {type: integer} phaseGroups: {type: integer} vehicleDetectors: {type: integer} pedestrianDetectors: {type: integer} alarmGroups: {type: integer} specialFunctionOutputs: {type: integer} patternsParameter: {type: integer} splits: {type: integer} timeBaseActions: {type: integer} preempts: {type: integer} rings: {type: integer} sequences: {type: integer} ringControlGroups: {type: integer} channels: {type: integer} channelStatusGroups: {type: integer} overlaps: {type: integer} overlapStatusGroups: {type: integer} scheduleEntries: {type: integer} dayPlans: {type: integer} dayPlanEvents: {type: integer} CoordinationParameters: type: object description: Coordination parameters for signal timing properties: correctionMode: {type: integer} maximumMode: {type: integer} forceMode: {type: integer} unitCoordinationSyncPoint: {type: integer}