Exhibit G-LPR HIT PUSH API.pdf

PDF 294 KB Posted

Attached to
Automated Bus Land and Bus Stop Enforcement System (Hardware & Software)
Solicitation number
BD-26-1206-40000-40000-119832
Issued by
Suffolk County, Massachusetts

About this file

This document is a technical overview of the LPR (License Plate Recognition) HitPush API developed by gtechna, dated 2025-08-01. The API is designed for law enforcement and parking enforcement agencies to record and process license plate recognition events across various scenarios, including bus lane violations, parking rights zone infractions, and permit zone violations. The technical specification provides comprehensive details about the API's data structure, including required and optional fields for capturing event information such as source, date, time, vehicle plate, state, GPS coordinates, and multiple types of associated images (plate picture, black and white picture, color picture, and context pictures).

The API supports multiple violation types and alert mechanisms, with flexible data capture including optional fields for agent badge numbers, client device IDs, street names, district codes, parking space numbers, and precise GPS location tracking. The system can handle different event types (reading with no alert, alert, misread) and supports various alert categories like hotlist alerts, timing alerts, parking rights alerts, permit alerts, and towing indicators. The documentation includes detailed JSON example payloads demonstrating different violation scenarios, such as GPS-based, parking rights zone-based, and permit zone-based violation alerts, with a standard response format returning a unique ID for each created LPR event.

View the file

Other files

File Type Posted
RFP 100-25 Form D Bidder Pricing Template rev.1.xlsx XLSX spreadsheet
RFP 100 25 Automated Bus Lane and Stop Enforcement System v7.pdf PDF
Exhibit K-MBTA Accessibility Requirements.docx DOCX document
Exhibit B-MBTA Bus Fleet.pdf PDF
Exhibit A-VDS Deployment Plan.xlsx XLSX spreadsheet
RFP 100 25 Technical Response Form B.xlsx XLSX spreadsheet
Exhibit I-Cloud Computing Terms.docx DOCX document
Exhibit I-Cloud Computing Terms~2.docx DOCX document
Exhibit F-Bus Zone Violation Thresholds.pdf PDF
Exhibit D-MBTA Bus Lane Designs.pdf PDF
Exhibit C-MBTA Bus Lanes List.xlsx XLSX spreadsheet
Exhibit H-OpenAPI Spec.yaml YAML file
Exhibit E-MBTA Bus Lanes Map.png PNG image
Show all 13

On GovTribe

Work with this file

  • Download the original file
  • Contacts named in this file
  • Similar government files
  • Ask GovTribe AI about this file

Text version

LPR HIT PUSH API

Technical Overview

2025-08-01

Officer Lpr API

Overview Officer LPR endpoint

Paths

POST /api/v1/lprEvents Operation used for creating a LPR Event

Responses

Code Description Links

200 OK

Content

No Links

401 Unauthorized

Content application/json

No Links

407 Bad Request

Content application/json

No Links

501 Server Exception

Content application/json

No Links

Components

Schemas

MessageResponseJson

Properties

Name Description Schema code optional integer (int32)

Name Description Schema type optional enum

(SUCCESS,WAR

NING,ERROR,I

NFO)

message optional string moduleId optional enum (system,officer cc,auth,commu nicator,parkin g_rights,pendi ng_ticket,rate_ calculator,ticke t,general) messageArgs optional

< object > array messageId optional string messageArg optional write only object

MessageResponseDto

Properties

Name Description Schema status optional string operation optional string message optional string

OrganizationDto

Properties

Name Description Schema id optional integer (int64) name optional string address optional string city optional string province optional string postalCode optional string timeZone optional string

BaseLprEventRequestDto

Related LPR hit for this LPR Event. Used for time hits

Properties

Name Description Schema source required

Source (Examples: A-ARH, E-Elsag, G-Genetec, I-Imense, P- PIPS/3M, M-Manual, TanneryCreek, Vigilant) string eventDate required

Local Date, if empty, will be computed from eventDateTime (using organization or default time zone) field.

string (YYYY-mm-dd) eventTime required

Local Time, if empty, will be computed from eventDateTime (using organization or default time zone) field string (hh:mm:ss) eventDateTime required

DateTime. At least eventDate/eventTime or eventDateTime field is required. If eventDateTime is provided and eventDate/eventTime field is null then eventDate/eventTime will be calculated from eventDateTime. The eventDateTime is in ISO 8601 format string (YYYY-

MM-

DDThh:mm:ss[.

mmm]TZD) plate required Vehicle plate

Maximum Length: 40 string state optional Vehicle state/province code

Maximum Length: 3 string organization optional

OrganizationId Dto agentNo optional

Agent number or username

Maximum Length: 10 string agentBadgeNo optional

Agent badge number

Maximum Length: 10 string clientId optional

Client device ID (or Device Id) doing the enforcement.

Maximum Length: 15 string vehicleNo optional

The number or uuid of the vehicle doing the enforcement

Maximum Length: 10 string civicNo optional

Civic number

Maximum Length: 10 string streetName optional

Street name

Maximum Length: 50 string districtCode optional

DistrictCode

Maximum Length: 5 string spaceNo optional

Parking Space number

Maximum Length: 10 string parkingRightsZ one optional

Parking Rights Zone Code (NULL-parking rights mode was off, else parking rights zone of enforcement)

Maximum Length: 50 string gpsLatitude optional

Location GPS Latitude

Maximum Length: 12 string gpsLongitude optional

Location GPS Longitude

Maximum Length: 12 string gpsQuality optional

GPS Signal Quality

Maximum Length: 12 string eventMsg optional

Event alert message

Maximum Length: 4000 string lprEventResult Type optional

LprEventResul tTypeCodeDto eventType optional

Event Type (NULL-Reading with no alert, A-Alert, M-Misread)

Maximum Length: 1 Default: A string hotlistAlert optional

Hot list alert (=NULL= feature was off, =T= True, =F= False)

Maximum Length: 1 string timingAlert optional

Timing alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 parkingRights Alert optional

ParkingRights alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string sharedPermitA lert optional

Shared Permit alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string permitAlert optional

Permit alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string parkingRights AlertType optional

Parking rights alert type (=E= Expired, =U= Unpaid, =D= Double Verification Failure)

Maximum Length: 1 string towing optional

Towing indicator (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string warning optional

Warning indicator (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string lprEventIgnore Reason optional

LprEventIgnor eReasonInputD to plateRectStartX optional

Plate rectangle startX within bwPicture or color Picture integer (int32) plateRectStartY optional

Plate rectangle startY within bwPicture or color Picture integer (int32) plateRectEndX optional

Plate rectangle endX within bwPicture or color Picture integer (int32) plateRectEndY optional

Plate rectangle endY within bwPicture or color Picture integer (int32) platePicture optional

Plate Picture (base64) string (byte) bwPicture optional

Black & White Picture (base64) string (byte) colorPicture optional

Color Picture (base64) string (byte) contextPicture s optional

List of all context Pictures < LprEventPictur eDto > array

LprEventIgnoreReasonInputDto

Ignore reason message

Maximum Length: 100

Properties

Name Description Schema ignoreReason optional

Ignore reason

Maximum Length: 100 string

LprEventPictureDto

List of all context Pictures

Properties

Name Description Schema picture optional

Context Picture (base64) string (byte) context optional

Context or Description

Maximum Length: 200 string pictureDate optional

Picture Date (Local Date) string (YYYY-mm-dd) pictureTime optional

Picture Time (Local Time)

Maximum Length: 8 string (HH:mm:ss)

LprEventRequestDto

Properties

Name Description Schema source required

Source (Examples: A-ARH, E-Elsag, G-Genetec, I-Imense, P- PIPS/3M, M-Manual, TanneryCreek, Vigilant) string eventDate required

Local Date, if empty, will be computed from eventDateTime (using organization or default time zone) field.

string (YYYY-mm-dd) eventTime required

Local Time, if empty, will be computed from eventDateTime (using organization or default time zone) field string (hh:mm:ss) eventDateTime required

DateTime. At least eventDate/eventTime or eventDateTime field is required. If eventDateTime is provided and eventDate/eventTime field is null then eventDate/eventTime will be calculated from eventDateTime. The eventDateTime is in ISO 8601 format string (YYYY-

MM-

DDThh:mm:ss[.

mmm]TZD) plate required Vehicle plate

Maximum Length: 40 string state optional Vehicle state/province code

Maximum Length: 3 string organization optional

OrganizationId Dto agentNo optional

Agent number or username

Maximum Length: 10 string agentBadgeNo optional

Agent badge number

Maximum Length: 10 string clientId optional

Client device ID (or Device Id) doing the enforcement.

Maximum Length: 15 string vehicleNo optional

The number or uuid of the vehicle doing the enforcement

Maximum Length: 10 string civicNo optional

Civic number

Maximum Length: 10 string streetName optional

Street name

Maximum Length: 50 string districtCode optional

DistrictCode

Maximum Length: 5 string spaceNo optional

Parking Space number

Maximum Length: 10 string parkingRightsZ one optional

Parking Rights Zone Code (NULL-parking rights mode was off, else parking rights zone of enforcement)

Maximum Length: 50 string gpsLatitude optional

Location GPS Latitude

Maximum Length: 12 gpsLongitude optional

Location GPS Longitude

Maximum Length: 12 string gpsQuality optional

GPS Signal Quality

Maximum Length: 12 string eventMsg optional

Event alert message

Maximum Length: 4000 string lprEventResult Type optional

LprEventResul tTypeCodeDto eventType optional

Event Type (NULL-Reading with no alert, A-Alert, M-Misread)

Maximum Length: 1 Default: A string hotlistAlert optional

Hot list alert (=NULL= feature was off, =T= True, =F= False)

Maximum Length: 1 string timingAlert optional

Timing alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string parkingRights Alert optional

ParkingRights alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string sharedPermitA lert optional

Shared Permit alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string permitAlert optional

Permit alert (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string parkingRights AlertType optional

Parking rights alert type (=E= Expired, =U= Unpaid, =D= Double Verification Failure)

Maximum Length: 1 string towing optional

Towing indicator (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 string warning optional

Warning indicator (=NULL -→ feature was off, =T -→ True, =F -→ False)

Maximum Length: 1 lprEventIgnore Reason optional

LprEventIgnor eReasonInputD to plateRectStartX optional

Plate rectangle startX within bwPicture or color Picture integer (int32) plateRectStartY optional

Plate rectangle startY within bwPicture or color Picture integer (int32) plateRectEndX optional

Plate rectangle endX within bwPicture or color Picture integer (int32) plateRectEndY optional

Plate rectangle endY within bwPicture or color Picture integer (int32) platePicture optional

Plate Picture (base64) string (byte) bwPicture optional

Black & White Picture (base64) string (byte) colorPicture optional

Color Picture (base64) string (byte) contextPicture s optional

List of all context Pictures < LprEventPictur eDto > array relatedLprEve nt optional

BaseLprEventR equestDto

LprEventResultTypeCodeDto

Identifies the type of LPR Event result (READ-no alert, HTL-Hotllist, etc. Valid codes can be found in LprEventResultType table. alternately, the boolean fields (hotlistAlert, timingAlert, parkingRightsAlert, permitAlert, sharedPermitAlert) can also be used to specify the type of alert.)

Maximum Length: 5

Properties

Name Description Schema code optional Result Type code

Maximum Length: 5 string

OrganizationIdDto

Organization (optional)

Properties id required Organization ID

Maximum Length: 8 integer (int64)

LprEventResponseDto

Properties

Name Description Schema id optional Created ID string

Bus Lane Violation Alert Examples

GPS-Based Violation Alert

"source": "gtechna", "agentBadgeNo": "gtechna", "eventDate": "2023-06-20", "eventTime": "08:00:01", "eventType": "A", "plate": "BUS002", "state": "QC", "lprEventResultType": { "code": "BUS" "platePicture": "-------------base64 String----------------

"bwPicture": "-------------base64 String-------------------

"colorPicture": "-------------base64 String----------------

"contextPictures": [ "picture": "-------------base64 String-----------------", "context": "string description 200", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "picture": "-------------base64 String-----------------", "context": "string description ", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "gpsLatitude": "45.5017", "gpsLongitude": "-73.5673", "gpsQuality": "High"

Parking Rights Zone-Based Violation Alert

"source": "gtechna", "agentBadgeNo": "gtechna", "eventDate": "2023-06-20", "eventTime": "08:00:01", "eventType": "A", "plate": "BUS002", "state": "QC", "lprEventResultType": { "code": "BUS" "platePicture": "-------------base64 String----------------

"bwPicture": "-------------base64 String-------------------

"colorPicture": "-------------base64 String----------------

"contextPictures": [ "picture": "-------------base64 String-----------------", "context": "string description 200", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "picture": "-------------base64 String-----------------", "context": "string description ", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "parkingRightsZone": "ZONE-123"

Permit Zone-Based Violation Alert

"source": "gtechna", "agentBadgeNo": "gtechna", "eventDate": "2023-06-20", "eventTime": "08:00:01", "eventType": "A", "plate": "BUS002", "state": "QC", "lprEventResultType": { "code": "BUS"

"platePicture": "-------------base64 String----------------

"bwPicture": "-------------base64 String-------------------

"colorPicture": "-------------base64 String----------------

"contextPictures": [ "picture": "-------------base64 String-----------------", "context": "string description 200", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "picture": "-------------base64 String-----------------", "context": "string description ", "pictureDate": "2023-06-20", "pictureTime": "08:00:01" "permitZone": "PERMIT-789"

Sample Response

HTTP/1.1 200 OK

"id" : “unique id of newly created LPR Event”

Officer Lpr API
Overview
Paths
POST /api/v1/lprEvents
Components
Schemas

File details come from the government source that posted it. Updated .